Skip to content

Commit d6ffa49

Browse files
committed
Improve release notes output
* Add more user friendly substitutions for area labels. * Add placeholder block for Kubernetes version support.
1 parent 2b0dd2e commit d6ffa49

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

hack/tools/release/notes.go

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,27 @@ var (
7272
tagRegex = regexp.MustCompile(`^\[release-[\w-\.]*\]`)
7373

7474
userFriendlyAreas = map[string]string{
75-
"e2e-testing": "e2e",
76-
"provider/control-plane-kubeadm": "KCP",
77-
"provider/infrastructure-docker": "CAPD",
78-
"dependency": "Dependency",
79-
"devtools": "Devtools",
80-
"machine": "Machine",
81-
"api": "API",
75+
"e2e-testing": "e2e",
76+
"provider/control-plane-kubeadm": "KCP",
77+
"provider/infrastructure-docker": "CAPD",
78+
"dependency": "Dependency",
79+
"devtools": "Devtools",
80+
"machine": "Machine",
81+
"api": "API",
82+
"machinepool": "MachinePool",
83+
"clustercachetracker": "ClusterCacheTracker",
84+
"clusterclass": "ClusterClass",
85+
"testing": "Testing",
86+
"release": "Release",
87+
"machineset": "MachineSet",
88+
"clusterresourceset": "ClusterResourceSet",
89+
"machinedeployment": "MachineDeployment",
90+
"ipam": "IPAM",
91+
"provider/bootstrap-kubeadm": "CAPBK",
92+
"provider/infrastructure-in-memory": "CAPIM",
93+
"provider/core": "Core",
94+
"runtime-sdk": "Runtime SDK",
95+
"ci": "CI",
8296
}
8397

8498
releaseBackportMarker = regexp.MustCompile(`(?m)^\[release-\d\.\d\]\s*`)
@@ -288,7 +302,15 @@ func run() int {
288302
}
289303

290304
// TODO Turn this into a link (requires knowing the project name + organization)
291-
fmt.Printf("Changes since %v\n---\n", commitRange)
305+
fmt.Print(`## 👌 Kubernetes version support
306+
307+
- Management Cluster: v1.**X**.x -> v1.**X**.x
308+
- Workload Cluster: v1.**X**.x -> v1.**X**.x
309+
310+
[More information about version support can be found here](https://cluster-api.sigs.k8s.io/reference/versions.html)
311+
312+
`)
313+
fmt.Printf("## Changes since %v\n---\n", commitRange)
292314

293315
fmt.Printf("## :chart_with_upwards_trend: Overview\n")
294316
if count := len(commits); count > 0 {

0 commit comments

Comments
 (0)