actions/metadata-action
1
0
Fork 0
mirror of https://github.com/docker/metadata-action.git synced 2024-11-22 12:05:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #359 from favonia/document-annotations

Browse Source 
docs(README): add a hint about multi-arch builds
This commit is contained in:
David Karlsson 2023-11-30 15:35:34 +01:00 committed by GitHub
commit 26b4721af7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -954,9 +954,17 @@ The same can be done with the [`bake-action`](https://github.com/docker/bake-act
targets: build
```
If you want to set specific level(s) for your annotations, you can use the
Note that annotations can be attached at many different levels within a manifest.
By default, the generated annotations will be attached to image manifests,
but different registries may expect annotations at different places;
a common practice is to read annotations at _image indexes_ if present,
which are often used by multi-arch builds to index platform-specific images.
If you want to specify level(s) for your annotations, you can use the
[`DOCKER_METADATA_ANNOTATIONS_LEVELS` environment variable](#environment-variables)
with a comma separated list of levels (defaults to `manifest`):
with a comma separated list of all levels the annotations should be attached to (defaults to `manifest`).
The following configuration demonstrates the ability to attach annotations to both image manifests and image indexes,
though your registry may only need annotations at the index level. (That is, `index` alone may be enough.)
Please consult the documentation of your registry.
```yaml
-