Skip to content

Document operator release artifacts and current acceptance limits #85

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

Merged
alimobrem merged 2 commits into from
Oct 3, 2026
Merged

Document operator release artifacts and current acceptance limits #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa84778
Document automated operator catalog release artifacts
amobrem Oct 3, 2026
18ab19b
Refresh Operator Pages with current release and cluster evidence
amobrem Oct 3, 2026
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
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,15 +739,22 @@ git push origin v0.2.0
```

CI ([`.github/workflows/release.yml`](.github/workflows/release.yml)) builds and pushes:
- `quay.io/amobrem/pulse-operator:v0.2.0` + `:latest` (the operator image, from `Dockerfile`)
- `quay.io/amobrem/pulse-operator-bundle:v0.2.0` + `:latest` (the OLM bundle, from `Dockerfile.bundle`)

Before the bundle image is built, CI runs [`scripts/bump-bundle-version.py`](scripts/bump-bundle-version.py) against the pushed tag, which updates the CSV's `metadata.name`, `spec.version`, `metadata.annotations.containerImage`, and the manager Deployment's `image` to match — and sets `spec.replaces` to whatever CSV name was current before the bump, extending the upgrade graph by one step. This runs in CI only; the version bump is never committed back to `main`, so `bundle/manifests/pulse-operator.clusterserviceversion.yaml` on `main` always reflects the most recently *released* version, not a preview of the next one.

The **catalog** image (`pulse-operator-catalog`, used by the CatalogSource in
[Install via OLM](#install-via-olm)) is *not* built by this workflow — publish it
manually via [Build the catalog image](#build-the-catalog-image) above after
tagging a release.
- `quay.io/amobrem/pulse-operator:<tag>` + `:latest` (the operator image, from `Dockerfile`)
- `quay.io/amobrem/pulse-operator-bundle:<tag>` + `:latest` (the OLM bundle, from `Dockerfile.bundle`)
- `quay.io/amobrem/pulse-operator-catalog:<tag>` + `:latest` (the file-based OLM catalog, from `Dockerfile.catalog`)

Before the bundle image is built, CI runs [`scripts/bump-bundle-version.py`](scripts/bump-bundle-version.py) against the pushed tag, which updates the CSV's `metadata.name`, `spec.version`, `metadata.annotations.containerImage`, and the manager Deployment's `image` to match — and sets `spec.replaces` to whatever CSV name was current before the bump, extending the upgrade graph by one step. This runs in CI only; the version bump is never committed back to `main`, so the checked-in CSV may lag the release; verify the published bundle rather than inferring its version from `main`.

The workflow renders available released bundles into the **catalog** image
(`pulse-operator-catalog`, used by the CatalogSource in [Install via OLM](#install-via-olm)),
and publishes it with the operator and bundle. The current bundle
must render successfully; unavailable historical bundles are skipped and
`replaces` is rewired to available predecessors. Verify the resulting upgrade
graph and all three published image digests before deployment.

Before tagging, update `internal/controller/compat.go`
`OperatorVersion` to the tag without `v`; the release workflow rejects a mismatch.
These image publications do not themselves create a GitHub Release.

Requires `QUAY_USERNAME` and `QUAY_TOKEN` as GitHub repository secrets.

Expand Down
Loading
Loading