Skip to content

Commit

Permalink
cnf-tests: elaborated instructions for branching in readme.md
Browse files Browse the repository at this point in the history
We've recently faced issues due to misaligned cnf-tests container images.
Since it's easy to forget updating the image version across the repo, these changes to the branching guide are necessary to cover (hopefully) all required updates when creating a new release branch.
The intention is for anyone creating the release-x.y branch to follow this, minimizing the chances of misalignments.
Additionally, we plan to implement automation in the CI that will trigger a failure if these instructions are not followed.

Signed-off-by: Ronny Baturov <[email protected]>
  • Loading branch information
rbaturov committed Jan 23, 2025
1 parent 90023fd commit aec82a9
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,12 +99,29 @@ This repository follows the same version numbering and release branching schedul

### Branching

1. Create a new 'release-x.y' branch and push it into Git
2. Advance the CI configuration in openshift/release to create new lanes for the release branch and move the master along to the next release version number
1. Before creating a new `release-x.y` branch ensure the new `x.y`version is reflected in the following sources:
- `cnf-tests/dockerfile.openshift`:
1. Check image tags used.
2. `CNF_TESTS_IMAGE` and `DPDK_TESTS_IMAGE` variables tags.

- `cnf-tests/Dockerfile.konflux`:
1. Check image tags used.
2. `CNF_TESTS_IMAGE` and `DPDK_TESTS_IMAGE` variables tags.
3. Check the tags in the strings of `RUN sed` commands.

- `cnf-tests/mirror/images.json`
- `cnf-tests/testsuites/pkg/images/images.go`
- `hack/common.sh`
- `hack/run-functests.sh`

2. If any sources require updates, create a pull request against the master branch with the necessary changes. Merge this PR before proceeding to the next steps.
2. Create a new `release-x.y` branch and push it to git
3. Advance the CI configuration in openshift/release to create new lanes for the release branch and move the master along to the next release version number
- Example: https://github.com/openshift/release/pull/26172
3. Change the ZTP templates examples label `du-profile: latest` under [gitops-subscriptions/argocd/example](https://github.com/openshift-kni/cnf-features-deploy/tree/master/ztp/gitops-subscriptions/argocd/example) to match the branch release-x.y
4. Change the ZTP templates examples label `du-profile: latest` under [gitops-subscriptions/argocd/example](https://github.com/openshift-kni/cnf-features-deploy/tree/master/ztp/gitops-subscriptions/argocd/example) to match the branch release-x.y
- PGT Example: https://github.com/openshift-kni/cnf-features-deploy/pull/1063
- SiteConfig Example: https://github.com/openshift-kni/cnf-features-deploy/pull/1064
4. Pin all midstream branches to the new release branch, and create new midstream branches for the next release
5. Pin all midstream branches to the new release branch, and create new midstream branches for the next release
- [cnf-tests](https://code.engineering.redhat.com/gerrit/admin/repos/cnf-tests)
- [ztp-site-generate](https://code.engineering.redhat.com/gerrit/admin/repos/ztp-site-generate)
6. Create a PR to the master branch updating the references from the first step to version `x.y+1`

0 comments on commit aec82a9

Please sign in to comment.