Skip to content

Commit 26b4721

Browse files
authored
Merge pull request #359 from favonia/document-annotations
docs(README): add a hint about multi-arch builds
2 parents f19c369 + 91224bc commit 26b4721

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -954,9 +954,17 @@ The same can be done with the [`bake-action`](https://github.com/docker/bake-act
954954
targets: build
955955
```
956956

957-
If you want to set specific level(s) for your annotations, you can use the
957+
Note that annotations can be attached at many different levels within a manifest.
958+
By default, the generated annotations will be attached to image manifests,
959+
but different registries may expect annotations at different places;
960+
a common practice is to read annotations at _image indexes_ if present,
961+
which are often used by multi-arch builds to index platform-specific images.
962+
If you want to specify level(s) for your annotations, you can use the
958963
[`DOCKER_METADATA_ANNOTATIONS_LEVELS` environment variable](#environment-variables)
959-
with a comma separated list of levels (defaults to `manifest`):
964+
with a comma separated list of all levels the annotations should be attached to (defaults to `manifest`).
965+
The following configuration demonstrates the ability to attach annotations to both image manifests and image indexes,
966+
though your registry may only need annotations at the index level. (That is, `index` alone may be enough.)
967+
Please consult the documentation of your registry.
960968

961969
```yaml
962970
-

0 commit comments

Comments
 (0)