Skip to content

Commit aeeb533

Browse files
authored
Merge pull request #8613 from mercedes-benz/adjust-polish-release-notes-section
📖 Adjust release notes section to reduce the chance of wrong copy paste
2 parents 88face9 + 631a0c0 commit aeeb533

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/release/release-tasks.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,12 +325,14 @@ The goal of this task to make the book for the current release available under e
325325
3. Finalize the release notes:
326326
1. Copy & paste the release notes into a hackmd (makes collaboration very easy).
327327
2. Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted.
328-
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)).
328+
3. Ensure consistent formatting of entries (e.g. prefix).
329+
<br>**Note**: Check against the release notes of the [previous release](https://github.com/kubernetes-sigs/cluster-api/releases/latest), depending on the release branch you are currently working on (e.g. v1.3.6 when working on v1.3.7 or v1.4.2 when working on v1.4.3).
329330
4. Merge dependency bump PR entries for the same dependency into a single entry.
330331
5. Move minor changes into a single line at the end of each section.
331332
6. Sort entries within a section alphabetically.
332333
7. Write highlights section based on the initial release notes doc.
333-
8. Add Kubernetes version support section.
334+
8. Add the Kubernetes version support section and pay close attention to set the correct versions here.
335+
<br>**Note**: Check our [Kubernetes support policy](https://cluster-api.sigs.k8s.io/reference/versions.html#supported-kubernetes-versions) in the CAPI book. In case of doubt, reach out to the current release lead.
334336
9. Modify `Changes since v1.x.y` to `Changes since v1.x`
335337
<br>**Note**: The release notes tool includes all merges since the previous release branch was branched of.
336338
4. Iterate until the GA release by generating incremental release notes and modifying the release notes in hackmd accordingly:

0 commit comments

Comments
 (0)