Skip to content

Commit d0ad33a

Browse files
authored
Merge pull request #3581 from sbueringer/pr-update-release-docs
📖 Update and simplify release docs
2 parents 2c660c0 + 3a5d0e6 commit d0ad33a

File tree

1 file changed

+12
-22
lines changed

1 file changed

+12
-22
lines changed

docs/release/release-tasks.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -92,23 +92,17 @@ From this point forward changes which should land in the release have to be cher
9292
2. Create the milestone for the new release via [GitHub UI](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/milestones/new).
9393
3. Update the [milestone applier config](https://github.com/kubernetes/test-infra/blob/151bab62dc023525f592e6d1fdc2a8de5305cd01/config/prow/plugins.yaml#L523) accordingly (e.g. `release-1.8: v1.8`
9494
and `main: v1.9`)
95-
4. Create new jobs based on the jobs running against our `main` branch:
96-
1. Copy the `.branches.main` section in `config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/cluster-api-provider-vsphere-prowjob-gen.yaml` over to a new branch specific section (e.g. `.branches.release-1.8`).
97-
2. Run `TEST_INFRA_DIR=../../k8s.io/test-infra make generate-test-infra-prowjobs` to regenerate the prowjob files.
95+
4. Update Jobs:
96+
1. Create new jobs based on the jobs running against our `main` branch:
97+
1. Copy the `.branches.main` section in `config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/cluster-api-provider-vsphere-prowjob-gen.yaml` over to a new branch specific section (e.g. `.branches.release-1.8`).
98+
2. Remove jobs for the old release branch that is not supported anymore by removing the release-branch from `cluster-api-provider-vsphere-prowjob-gen.yaml`.
99+
3. Run `TEST_INFRA_DIR=../../k8s.io/test-infra make generate-test-infra-prowjobs` to regenerate the prowjob files.
98100
5. Verify the jobs and dashboards a day later by taking a look at [testgrid](https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-vsphere)
99-
6. Update for the currently supported branches:
101+
6. Update for the currently supported branches (also remove the release branch that is not supported anymore):
100102
* `.github/workflows/weekly-security-scan.yaml`: to setup Trivy and govulncheck scanning
101103
* `.github/workflows/weekly-md-link-check.yaml`: to setup link checking in the CAPI book
102104
* `.github/workflows/weekly-test-release.yaml`: to verify the release target is working
103105

104-
After the release is cut:
105-
106-
1. Remove tests for old release branches if necessary by removing the release-branch from `cluster-api-provider-vsphere-prowjob-gen.yaml` and regenerating the prowjob files.
107-
2. Update to remove the not supported release-branch:
108-
* `.github/workflows/weekly-security-scan.yaml`: to setup Trivy and govulncheck scanning
109-
* `.github/workflows/weekly-md-link-check.yaml`: to setup link checking in the CAPI book
110-
* `.github/workflows/weekly-test-release.yaml`: to verify the release target is working
111-
112106
## Cut a release
113107

114108
1. Ensure via testgrid that CI is stable before cutting the release
@@ -162,17 +156,13 @@ After the release is cut:
162156
```
163157

164158
5. Publish the release.
165-
1. Finalize release notes
166-
1. Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted.
167-
2. Ensure consistent formatting of entries (e.g. prefix).
168-
3. Merge dependency bump PR entries for the same dependency into a single entry.
169-
4. Move minor changes into a single line at the end of each section.
170-
5. Sort entries within a section alphabetically.
171-
6. Write highlights section based on the initial release notes doc. (for minor releases and important changes only)
172-
7. **For minor releases** Modify `Changes since v1.x.y` to `Changes since v1.x`
159+
1. Finalize release notes
160+
1. Write highlights section (for important changes only)
161+
2. **For minor releases** Modify `Changes since v1.x.y` to `Changes since v1.x`
173162
**Note**: The release notes tool includes all merges since the previous release branch was branched of.
174-
2. Publish the release and ensure release is flagged as `pre-release` for all `beta` and `rc` releases or `latest` for a new release in the most recent release branch.
175-
6. **For minor releases** Update supported versions in README.md.
163+
2. Publish the release and ensure release is flagged as `pre-release` for all `alpha`, `beta` and `rc` releases or `latest` for a new release in the most recent release branch.
164+
6. **For the rc.0 release** Also [create the release branch](#create-a-release-branch). From now on every PR for the release has to be cherry-picked to the release branch!
165+
7. **For minor releases** Update supported versions in README.md.
176166

177167
- Cutting a release as of today requires permissions to:
178168
- Create a release tag on the GitHub repository.

0 commit comments

Comments
 (0)