Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to note that index annotations fail if an index is not produced #4121

Merged
merged 1 commit into from
Aug 8, 2023
Merged

Update docs to note that index annotations fail if an index is not produced #4121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/annotations.md
View file
Open in desktop
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