huoxue1
/
metadata-action
mirror of https://github.com/docker/metadata-action.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(README): add a hint about multi-arch builds 

Document probably the most common usage of
`DOCKER_METADATA_ANNOTATIONS_LEVELS`: multi-arch builds.

Signed-off-by: favonia <favonia@gmail.com>
This commit is contained in:
favonia 2023-11-30 06:27:49 -06:00
parent f19c3691d5
commit 91224bc155
No known key found for this signature in database
GPG Key ID: 06210CB7076F1EEC
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
-