Skip to content

Commit 489be72

Browse files
davdhacsclaude
andcommitted
docs: add step-by-step guide for CI image changes
Address review feedback requesting a concrete walkthrough for someone bumping a dependency, including the coordination note about the single `latest` tag. Partially generated by AI. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 7a0bdf9 commit 489be72

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,30 @@ To mirror a new versioned tag for release branch use:
5656
The `latest` and `stable` floating tags are mirrored once and do not need
5757
updates per version.
5858

59+
## Step-by-step: Making a CI Image Change
60+
61+
Example: you need to bump a dependency or add a tool to the CI image.
62+
63+
1. **Make your change** on a branch and open a PR in this repo.
64+
2. **Merge to main** -- once approved, merge the PR. The `tag.yaml` workflow
65+
auto-creates a semver tag (e.g. `0.5.8`).
66+
3. **Wait for the build** -- the `build.yaml` workflow builds all image flavors
67+
and pushes both versioned and `latest` tags to quay.io.
68+
4. **Test in openshift/release** -- open a PR in `openshift/release` that
69+
references the `latest` tag and run `/pj-rehearse` to validate affected
70+
prow jobs. No config change is needed if the jobs already use `latest`.
71+
5. **Promote to stable** -- once rehearsals pass, [run the promote-stable
72+
workflow](https://github.com/stackrox/rox-ci-image/actions/workflows/promote-stable.yaml)
73+
(or `gh workflow run promote-stable.yaml`). This retags `latest``stable`.
74+
Master/nightly prow jobs pick up the new image automatically.
75+
6. **Pin release branches** (if needed) -- for release branch configs, update
76+
`openshift/release` to reference the specific versioned tag
77+
(e.g. `stackrox-test-0.5.8`). This requires testplatform review.
78+
79+
> **Note:** There is only one `latest` tag per flavor, so only one
80+
> rox-ci-image change can be tested via rehearsal at a time. Coordinate
81+
> with others if multiple changes are in flight.
82+
5983
## Updating the Go Version
6084

6185
To bump the Go version across all Docker images in this repository, use the automated script:

0 commit comments

Comments
 (0)