Skip to content

Commit 0c166ea

Browse files
Add notes about IPv6 tests in the release tasks
1 parent a8a0a58 commit 0c166ea

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

docs/release/release-tasks.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ This document details the responsibilities and tasks for each role in the releas
55
**Notes**:
66
* The examples in this document are based on the v1.4 release cycle.
77
* This document focuses on tasks that are done for every release. One-time improvement tasks are out of scope.
8-
* If a task is prefixed with `[Track]` it means it should be ensured that this task is done, but the folks with
9-
the corresponding role are not responsible to do it themselves.
8+
* If a task is prefixed with `[Track]` it means it should be ensured that this task is done, but the folks with
9+
the corresponding role are not responsible to do it themselves.
1010

1111
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1212
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -87,7 +87,7 @@ As of now we ask for volunteers in Slack and office hours.
8787

8888
#### Prepare main branch for development of the new release
8989

90-
The goal of this issue is to bump the versions on the main branch so that the upcoming release version
90+
The goal of this issue is to bump the versions on the main branch so that the upcoming release version
9191
is used for e.g. local development and e2e tests. We also modify tests so that they are testing the previous release.
9292

9393
This comes down to changing occurrences of the old version to the new version, e.g. `v1.3` to `v1.4`:
@@ -110,7 +110,7 @@ This comes down to changing occurrences of the old version to the new version, e
110110
we use in the clusterctl upgrade tests (as of today `cluster-template` and `cluster-template-topology`).
111111
2. Remove old folders that are not used anymore (for `v1.4` we don't have to remove any).
112112
5. Modify the test specs in `test/e2e/clusterctl_upgrade_test.go` (according to the versions we want to test described above).
113-
Please note that `InitWithKubernetesVersion` should be the highest mgmt cluster version supported by the respective Cluster API version.
113+
Please note that `InitWithKubernetesVersion` should be the highest mgmt cluster version supported by the respective Cluster API version.
114114
2. Update `create-local-repository.py` and `tools/tilt-prepare/main.go`: `v1.3.99` => `v1.4.99`.
115115
3. Update `.github/workflows/scan.yml` - to setup Trivy scanning - and `.github/workflows/lint-docs-weekly.yml` - to setup link checking in the CAPI book - for the currently supported branches.
116116
4. Make sure all tests are green (also run `pull-cluster-api-e2e-full-main` and `pull-cluster-api-e2e-workload-upgrade-1-23-latest-main`).
@@ -152,7 +152,7 @@ From this point forward changes which should land in the release have to be cher
152152
```bash
153153
# Create the release branch
154154
git checkout -b release-1.4
155-
155+
156156
# Push the release branch
157157
# Note: `upstream` must be the remote pointing to `github.com/kubernetes-sigs/cluster-api`.
158158
git push -u upstream release-1.4
@@ -162,7 +162,7 @@ From this point forward changes which should land in the release have to be cher
162162

163163
#### [Continuously] Maintain the GitHub release milestone
164164

165-
The goal of this task is to keep an overview over the current release milestone and the implementation
165+
The goal of this task is to keep an overview over the current release milestone and the implementation
166166
progress of issues assigned to the milestone.
167167

168168
This can be done by:
@@ -178,23 +178,23 @@ The goal of this task is to ensure we are always using the latest Go version for
178178
2. Bump the Go version in supported branches if necessary
179179
<br>Prior art: [Bump to Go 1.19.5](https://github.com/kubernetes-sigs/cluster-api/pull/7981)
180180

181-
Note: If the Go minor version of one of our supported branches goes out of supported, we should consider bumping
181+
Note: If the Go minor version of one of our supported branches goes out of supported, we should consider bumping
182182
to a newer Go minor version according to our [backport policy](./../../CONTRIBUTING.md#backporting-a-patch).
183183

184184
#### [Repeatedly] Cut a release
185185

186186
1. Ensure CI is stable before cutting the release (e.g. by checking with the CI manager)
187187
Note: special attention should be given to image scan results, so we can avoid cutting a release with CVE or document known CVEs in release notes.
188188
2. Create and push the release tags to the GitHub repository:
189-
```bash
189+
```bash
190190
# Export the tag of the release to be cut, e.g.:
191191
export RELEASE_TAG=v1.0.1
192-
192+
193193
# Create tags locally
194194
# Warning: The test tag MUST NOT be an annotated tag.
195195
git tag -s -a ${RELEASE_TAG} -m ${RELEASE_TAG}
196196
git tag test/${RELEASE_TAG}
197-
197+
198198
# Push tags
199199
# Note: `upstream` must be the remote pointing to `github.com/kubernetes-sigs/cluster-api`.
200200
git push upstream ${RELEASE_TAG}
@@ -205,7 +205,7 @@ to a newer Go minor version according to our [backport policy](./../../CONTRIBUT
205205
1. Wait until images for the tag have been built and pushed to the [staging repository](https://console.cloud.google.com/gcr/images/k8s-staging-cluster-api) by the [post push images job](https://prow.k8s.io/?repo=kubernetes-sigs%2Fcluster-api&job=post-cluster-api-push-images).
206206
2. If you don't have a GitHub token, create one by going to your GitHub settings, in [Personal access tokens](https://github.com/settings/tokens). Make sure you give the token the `repo` scope.
207207
3. Create a PR to promote the images to the production registry:
208-
```bash
208+
```bash
209209
export GITHUB_TOKEN=<your GH token>
210210
make promote-images
211211
```
@@ -214,7 +214,7 @@ to a newer Go minor version according to our [backport policy](./../../CONTRIBUT
214214
git to use `https` instead via `git config --global url."https://github.com/".insteadOf [email protected]:`.
215215
* This will automatically create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the CAPI maintainers.
216216
4. Merge the PR (/lgtm + /hold cancel) and verify the images are available in the production registry:
217-
```bash
217+
```bash
218218
docker pull registry.k8s.io/cluster-api/clusterctl:${RELEASE_TAG}
219219
docker pull registry.k8s.io/cluster-api/cluster-api-controller:${RELEASE_TAG}
220220
docker pull registry.k8s.io/cluster-api/kubeadm-bootstrap-controller:${RELEASE_TAG}
@@ -226,7 +226,7 @@ to a newer Go minor version according to our [backport policy](./../../CONTRIBUT
226226
5. Publish `clusterctl` to Homebrew by bumping the version in [clusterctl.rb](https://github.com/Homebrew/homebrew-core/blob/master/Formula/clusterctl.rb).
227227
<br>**Notes**:
228228
* This is only done for new latest stable releases, not for beta / RC releases and not for previous release branches.
229-
* Check if homebrew already has a PR to update the version (homebrew introduced automation that picks it up). Open one if no PR exists.
229+
* Check if homebrew already has a PR to update the version (homebrew introduced automation that picks it up). Open one if no PR exists.
230230
* For an example please see: [PR: clusterctl 1.1.5](https://github.com/Homebrew/homebrew-core/pull/105075/files).
231231
* Homebrew has [conventions for commit messages](https://docs.brew.sh/Formula-Cookbook#commit) usually
232232
the commit message for us should look like: `clusterctl 1.1.5`.
@@ -278,8 +278,8 @@ Additional information:
278278
#### Add docs to collect release notes for users and migration notes for provider implementers
279279
280280
The goal of this task is to initially create the docs so that we can continuously add notes going forward.
281-
The release notes doc will be used to collect release notes during the release cycle and will be eventually
282-
used to write the final release notes. The provider migration doc is part of the book and contains instructions
281+
The release notes doc will be used to collect release notes during the release cycle and will be eventually
282+
used to write the final release notes. The provider migration doc is part of the book and contains instructions
283283
for provider authors on how to adopt to the new Cluster API version.
284284
285285
1. Add a new migration doc for provider implementers.
@@ -291,7 +291,7 @@ for provider authors on how to adopt to the new Cluster API version.
291291
1. Update supported versions in versions.md.
292292
<br>Prior art: [Update supported versions for v1.3](https://github.com/kubernetes-sigs/cluster-api/pull/6850)
293293
294-
#### Ensure the book for the new release is available
294+
#### Ensure the book for the new release is available
295295
296296
The goal of this task to make the book for the current release available under e.g. `https://release-1-4.cluster-api.sigs.k8s.io`.
297297
@@ -317,7 +317,7 @@ The goal of this task to make the book for the current release available under e
317317
3. Ensure consistent formatting of entries (e.g. prefix (see [v1.2.0](https://github.com/kubernetes-sigs/cluster-api/releases/tag/v1.2.0) release notes)).
318318
4. Merge dependency bump PR entries for the same dependency into a single entry.
319319
5. Move minor changes into a single line at the end of each section.
320-
6. Sort entries within a section alphabetically.
320+
6. Sort entries within a section alphabetically.
321321
7. Write highlights section based on the initial release notes doc.
322322
8. Add Kubernetes version support section.
323323
9. Modify `Changes since v1.x.y` to `Changes since v1.x`
@@ -337,7 +337,7 @@ Someone with access to Netlify should:
337337
1. Change production branch in Netlify the current release branch (e.g. `release-1.4`) to make the book available under `https://cluster-api.sigs.k8s.io`.
338338
2. Re-deploy via the Netlify UI.
339339
340-
#### Update clusterctl links in the quickstart
340+
#### Update clusterctl links in the quickstart
341341
342342
The goal of this task is to ensure the quickstart has links to the latest `clusterctl` binaries.
343343
@@ -421,6 +421,7 @@ The goal of this task is to keep our tests running in CI stable.
421421
3. Mark the issue as `release-blocking` if applicable.
422422
4. Triage periodic GitHub actions failures, with special attention to image scan results;
423423
Eventually open issues as described above.
424+
5. Monitor IPv6 testing PR informing jobs (look for `capi-pr-e2e-informing-ipv6-<branch_name>` tab on main and supported releases testgrid dashboards), since they are not part of any periodic jobs.
424425

425426
#### [Continuously] Reduce the amount of flaky tests
426427

@@ -441,5 +442,5 @@ To reduce the amount of flakes please periodically:
441442
The goal of bug triage is to triage incoming issues and if necessary flag them with `release-blocking`
442443
and add them to the milestone of the current release.
443444
444-
We probably have to figure out some details about the overlap between the bug triage task here, release leads
445+
We probably have to figure out some details about the overlap between the bug triage task here, release leads
445446
and Cluster API maintainers.

0 commit comments

Comments
 (0)