Skip to content

Commit ee71719

Browse files
authored
Merge pull request #8118 from sbueringer/pr-document-test-coverage
📖 docs: document test coverage for release branches
2 parents 9c9202e + a45fca7 commit ee71719

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,10 @@ Cluster API maintains the most recent release/releases for all supported API and
145145
| **v1alpha4** | EOL since 2022-04-06 ([apiVersion removal](#removal-of-v1alpha3--v1alpha4-apiversions)) |
146146
| **v1alpha3** | EOL since 2022-02-23 ([apiVersion removal](#removal-of-v1alpha3--v1alpha4-apiversions)) |
147147

148-
- For the latest API version we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
148+
- For the current stable API version (v1beta1) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
149149
- For older API versions we only support the most recent minor release until the API version reaches EOL.
150+
- We will maintain test coverage for all supported minor releases and for one additional release for the current stable API version in case we have to do an emergency patch release.
151+
For example, if v1.2 and v1.3 are currently supported, we will also maintain test coverage for v1.1 for one additional release cycle. When v1.4 is released, tests for v1.1 will be removed.
150152

151153
| Minor Release | API Version | Supported Until |
152154
|---------------|--------------|------------------------------------------------------|

docs/release/release-tasks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,7 @@ Stakeholders are: (TBD)
387387
#### Setup jobs and dashboards for a new release branch
388388
389389
The goal of this task is to have test coverage for the new release branch and results in testgrid.
390+
While we add test coverage for the new release branch we will also drop the tests for old release branches if necessary.
390391
391392
1. Create new jobs based on the jobs running against our `main` branch:
392393
1. Copy `config/jobs/kubernetes-sigs/cluster-api/cluster-api-periodics-main.yaml` to `config/jobs/kubernetes-sigs/cluster-api/cluster-api-periodics-release-1-4.yaml`.
@@ -401,7 +402,9 @@ The goal of this task is to have test coverage for the new release branch and re
401402
* Change interval (let's use the same as for `1.3`).
402403
5. For presubmits additionally: Adjust branches: `^main$` => `^release-1.4$`.
403404
2. Create a new dashboard for the new branch in: `test-infra/config/testgrids/kubernetes/sig-cluster-lifecycle/config.yaml` (`dashboard_groups` and `dashboards`).
404-
3. Verify the jobs and dashboards a day later by taking a look at: `https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-1.4`
405+
3. Remove tests for old release branches according to our policy documented in [Support and guarantees](../../CONTRIBUTING.md#support-and-guarantees)
406+
For example, let's assume we just created tests for v1.4, then we can now drop test coverage for the release-1.1 branch.
407+
4. Verify the jobs and dashboards a day later by taking a look at: `https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-1.4`
405408
406409
Prior art: [Add jobs for CAPI release 1.2](https://github.com/kubernetes/test-infra/pull/26621)
407410

0 commit comments

Comments
 (0)