Skip to content

Commit

Permalink
docs: index annotations fail if index is not produced
Browse files Browse the repository at this point in the history
Signed-off-by: Justin Chadwell <me@jedevc.com>
(cherry picked from commit 49c848e)
  • Loading branch information
jedevc authored and tonistiigi committed Aug 23, 2023
1 parent dc338bf commit 6864757
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,12 @@ write to the following `<type>`s:
- The `manifest` (the default, as above)
- The `manifest-descriptor`
- This adds the annotation into the image index's descriptor for the manifest
- (discarded if the output does not contain an image index)
- The `index`
- This adds the annotation into the image index root
- (discarded if the output does not contain an image index)
- If the exporter does not produce an image index, the build will fail.
- The `index-descriptor`
- This adds the annotation into the OCI layout's descriptor for the index
- (discarded if the output does not contain an OCI layout)
- If the exporter does not produce an image index, the build will fail.

For example, if you want to add the annotation at the image index level, so
that the annotation is shared between all architectures, you can instead:
Expand Down

0 comments on commit 6864757

Please sign in to comment.