📖 ci-signal: clarified timing for dropping n-3 release support in setup steps #12057
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/XS
|
/kind documentation |
k8s-ci-robot
added
the
kind/documentation
|
/area documentation |
k8s-ci-robot
added
area/documentation
shecodesmagic
changed the title
sbueringer
reviewed
Apr 7, 2025
k8s-ci-robot
added
size/S
sbueringer
reviewed
Apr 9, 2025
| @@ -37,7 +37,8 @@ While we add test coverage for the new release branch we will also drop the test | |||
| 2. Modify the following at the `release-1.8` branch entry: | |||
| * Change intervals (let's use the same as for `release-1.7`). | |||
| 2. Create a new dashboard for the new branch in: `test-infra/config/testgrids/kubernetes/sig-cluster-lifecycle/config.yaml` (`dashboard_groups` and `dashboards`). | |||
| 3. Remove old release branches and unused versions from the `cluster-api-prowjob-gen.yaml` file in [test-infra](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api/) according to our policy documented in [Support and guarantees](../../../../CONTRIBUTING.md#support-and-guarantees). As we just added `release-1.8`, then we can now drop test coverage for the `release-1.5` branch. | |||
| 3. Do not remove old release branches during this setup phase. | |||
| Per our policy documented in [Support and guarantees](../../../../CONTRIBUTING.md#support-and-guarantees), old release branches (e.g., `release-1.5`) should only be removed after the new release (v1.8.0) has been officially cut. This ensures continued support for n-3 versions throughout the current release cycle. Once `v1.8.0` is released, then test coverage for old release branches and unused versions (in this case `release-1.5`) may be removed from the `cluster-api-prowjob-gen.yaml` file in [test-infra](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api/). | |||
There was a problem hiding this comment.
Suggested change
| Per our policy documented in [Support and guarantees](../../../../CONTRIBUTING.md#support-and-guarantees), old release branches (e.g., `release-1.5`) should only be removed after the new release (v1.8.0) has been officially cut. This ensures continued support for n-3 versions throughout the current release cycle. Once `v1.8.0` is released, then test coverage for old release branches and unused versions (in this case `release-1.5`) may be removed from the `cluster-api-prowjob-gen.yaml` file in [test-infra](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api/). |
Let's drop this explanation here. I think it's okay to just say don't remove
| Once the new minor release (e.g., `v1.8.0`) has been officially cut, perform the following cleanup: | ||
|
|
||
| - Remove old release branches and unused versions from the `cluster-api-prowjob-gen.yaml` file in [test-infra](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api/) according to our policy documented in [Support and guarantees](../../../../CONTRIBUTING.md#support-and-guarantees). | ||
| As we just added `release-1.8`, we can now drop test coverage for the `release-1.5` branch. |
There was a problem hiding this comment.
Suggested change
| As we just added `release-1.8`, we can now drop test coverage for the `release-1.5` branch. | |
| We can now drop test coverage for branaches out of support (e.g. `release-1.5`). |
| ### Post-release cleanup | ||
| Once the new minor release (e.g., `v1.8.0`) has been officially cut, perform the following cleanup: | ||
|
|
||
| - Remove old release branches and unused versions from the `cluster-api-prowjob-gen.yaml` file in [test-infra](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api/) according to our policy documented in [Support and guarantees](../../../../CONTRIBUTING.md#support-and-guarantees). |
There was a problem hiding this comment.
I think this link "../../../../CONTRIBUTING.md#support-and-guarantees" is broken
There was a problem hiding this comment.
@fabriziopandini Can you please share where this should link to? I think somewhere in versions.md
| @@ -84,3 +85,10 @@ To reduce the amount of flakes please periodically: | |||
| 2. Open issues using an appropriate template (flaking-test) for occurring flakes and ideally fix them or find someone who can. | |||
|
|
|||
| **Note**: Given resource limitations in the Prow cluster it might not be possible to fix all flakes. Let's just try to pragmatically keep the amount of flakes pretty low. | |||
|
|
|||
| ### Post-release cleanup | |||
There was a problem hiding this comment.
Please add this to the table of contents, i.e. let's add
- [Post-release cleanup](#post-release-cleanup)
In l.15
| @@ -84,3 +85,10 @@ To reduce the amount of flakes please periodically: | |||
| 2. Open issues using an appropriate template (flaking-test) for occurring flakes and ideally fix them or find someone who can. | |||
|
|
|||
| **Note**: Given resource limitations in the Prow cluster it might not be possible to fix all flakes. Let's just try to pragmatically keep the amount of flakes pretty low. | |||
|
|
|||
| ### Post-release cleanup | |||
| Once the new minor release (e.g., `v1.8.0`) has been officially cut, perform the following cleanup: | |||
There was a problem hiding this comment.
Let's also add this to the release tracking issue template
* [ ] [CI Manager] [Post-release cleanup](https://github.com/kubernetes-sigs/cluster-api/tree/main/docs/release/role-handbooks/ci-signal#post-release-cleanup)
week 18 / l.67 in .github/ISSUE_TEMPLATE/release_tracking.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR updates the CI Signal handbook to clarify the timing for dropping support for n-3 release branches during the new release setup process.
Previously, the instructions implied that support for n-3 (e.g., release-1.7 during the v1.10 cycle) should be removed during the setup phase. However, during the v1.10 release, the team aligned on delaying this step until after the new minor release (e.g., v1.10.0) has been officially cut.
This update ensures consistency with current team practices and avoids premature removal of test coverage for supported versions.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #12025