Skip to content

docs: note bundle createdAt metadata updates #7101

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

Open
kiku-jw wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −0
Open

docs: note bundle createdAt metadata updates #7101

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
6 changes: 6 additions & 0 deletions website/content/en/docs/olm-integration/generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,12 @@ $ tree ./bundle
**Important:** bundle generation is supposed to be idempotent, so any changes to CSV fields able to be persisted
(marked _(user)_ or _(marker)_ [below](#csv-fields)) must be made to the base set of manifests, typically found in `config/`.

`make bundle` also refreshes release metadata in the generated bundle. For example, the generated CSV's
`metadata.annotations.createdAt` value is updated when the CSV is regenerated. If you run `make bundle` in CI to
check whether generated files are current, account for this metadata update instead of treating a `createdAt`-only
diff as a source manifest change. For pre-release checks that only need to verify source manifests, prefer checking
the manifests in `config/` before generating the release bundle.

Bundle metadata in `bundle/metadata/annotations.yaml` contains information about a particular Operator version
available in a registry. OLM uses this information to install specific Operator versions and resolve dependencies.
That file and `bundle.Dockerfile` contain the same [annotations][bundle-metadata], the latter as `LABEL`s,
Expand Down