🌱 Add additional blocks to release note generation #9247

mjlshen · 2023-08-20T02:59:27Z

What this PR does / why we need it:

This PR allows the existing release notes generation tool to generate (optionally in some cases) commonly used headers that have been manually filled out in the past:

An optional header when generating a release candidate
A highlights header with filler to manually replace
An optional header about deprecation warnings

Which issue(s) this PR fixes:

Fixes #9248
Part of #9104

Sample header output:

❯ go run hack/tools/release/notes.go -from release-1.5 -workers 1 -release-candidate -deprecation
🚨 This is a RELEASE CANDIDATE. Use it only for testing purposes. If you find any bugs, file an [issue](https://github.com/kubernetes-sigs/cluster-api/issues/new).
## 👌 Kubernetes version support

- Management Cluster: v1.**X**.x -> v1.**X**.x
- Workload Cluster: v1.**X**.x -> v1.**X**.x

[More information about version support can be found here](https://cluster-api.sigs.k8s.io/reference/versions.html)

## Highlights

* REPLACE ME

## Deprecation Warning

REPLACE ME: A couple sentences describing the deprecation, including links to docs.

* [GitHub issue #REPLACE ME](REPLACE ME)

## Changes since release-1.5

/area release

hack/tools/release/notes.go

mjlshen · 2023-08-20T03:10:09Z

cc @kubernetes-sigs/cluster-api-release-team

killianmuldoon

Looks generally good - one overall comment.

As this gets more complex it might be a good idea to move to Go templates. That way the information to fill out the additional headers can be maintained through the release cycle.

hack/tools/release/notes.go

furkatgofurov7

Overall lgtm, pending to clarify few open questions from reviewers and should be good to take it in! Thanks @mjlshen for working on this

hack/tools/release/notes.go

richardcase · 2023-08-24T12:05:50Z

As this gets more complex it might be a good idea to move to Go templates. That way the information to fill out the additional headers can be maintained through the release cycle.

I like the idea of using a go template. This would be similar to the kubernetes release-notes tool that uses go templates (see here). It also allows you to override the template

hack/tools/release/notes.go

mjlshen · 2023-08-25T02:18:21Z

I took a look at switching over to the kubernetes release tool here: #8292 (comment)

I think it's a bigger effort, so I'm leaning towards taking the easy win here and continuing discussion in the issue to see where we want to go next with this release notes tool (bigger refactor or changes upstream + switching over).

furkatgofurov7 · 2023-08-25T08:20:29Z

I took a look at switching over to the kubernetes release tool here: #8292 (comment)

I think it's a bigger effort, so I'm leaning towards taking the easy win here and continuing discussion in the issue to see where we want to go next with this release notes tool (bigger refactor or changes upstream + switching over).

Agree, currently, the best way forward for us should be to take this in and continue the switching over to the new process in the original issue.

/lgtm

k8s-ci-robot · 2023-08-25T08:20:35Z

LGTM label has been added.

Git tree hash: ef0e5ca56789693be9ea9847c69a7cebbd404705

richardcase · 2023-08-25T16:13:28Z

I think it's a bigger effort, so I'm leaning towards taking the easy win here and continuing discussion in the issue to see where we want to go next with this release notes tool (bigger refactor or changes upstream + switching over).

Sorry I wasn't suggesting that you adopt it, just pointing out that i think its a good idea to adopt a go template (as other tools have done).

mjlshen · 2023-08-25T16:15:47Z

Sorry I wasn't suggesting that you adopt it, just pointing out that i think its a good idea to adopt a go template (as other tools have done).

Oh no apology needed, it was a good suggestion! I was just sharing my initial findings/conclusion in case I got something wrong too

g-gaston · 2023-08-28T10:18:31Z

/lgtm

furkatgofurov7 · 2023-08-30T08:39:17Z

/cc @sbueringer when you have some spare time :)

furkatgofurov7 · 2023-08-30T16:45:26Z

/cc @vincepri

vincepri · 2023-08-30T16:47:50Z

hack/tools/release/notes.go

@@ -73,6 +73,8 @@ var (

 	prefixAreaLabel = flag.Bool("prefix-area-label", true, "If enabled, will prefix the area label.")

+	preReleaseVersion           = flag.Bool("pre-release-version", false, "If enabled, will add a pre-release warning header. (default false)")


Is this being set locally? Would there be a way to understand which tag we're running against and set this flag automatically? For example: v1.0.0-beta.1 I'd expect the same behavior, and similar for alpha.X or rc.X

Ah we talked about this here: #9247 (comment) it's doable long-term with a bigger refactor, but we're mostly just trying to make sure we have the standardized formatting somewhere

mjlshen · 2023-09-01T13:04:25Z

cc @killianmuldoon / @vincepri wondering if you think this PR is ok to merge? I will be working on a refactor of this tool through #9249 for example, but this PR's goal is mostly to get standardized wording in.

sbueringer

Just a few nits

hack/tools/release/notes.go

* An optional header when generating a release candidate * A highlights header with filler to manually replace * An optional header about deprecation warnings Signed-off-by: Michael Shen <mishen@umich.edu>

willie-yao

/lgtm

k8s-ci-robot · 2023-09-01T18:47:03Z

LGTM label has been added.

Git tree hash: 14ce8be4d46142c01e711970c8bdd650c4f2ca43

furkatgofurov7 · 2023-09-04T06:34:49Z

/lgtm

sbueringer · 2023-09-04T09:20:21Z

Thx

/approve

k8s-ci-robot · 2023-09-04T09:20:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [sbueringer]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added area/release Issues or PRs related to releasing cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 20, 2023

k8s-ci-robot requested review from JoelSpeed and killianmuldoon August 20, 2023 02:59

mjlshen commented Aug 20, 2023

View reviewed changes

hack/tools/release/notes.go Show resolved Hide resolved

furkatgofurov7 mentioned this pull request Aug 20, 2023

Improvement tasks for v1.6 release cycle #9104

Closed

35 tasks

killianmuldoon reviewed Aug 21, 2023

View reviewed changes

hack/tools/release/notes.go Outdated Show resolved Hide resolved

g-gaston reviewed Aug 21, 2023

View reviewed changes

hack/tools/release/notes.go Outdated Show resolved Hide resolved

hack/tools/release/notes.go Show resolved Hide resolved

hack/tools/release/notes.go Outdated Show resolved Hide resolved

mjlshen force-pushed the missing-notes-sections branch from 29ccb61 to a8535b6 Compare August 22, 2023 01:23

furkatgofurov7 reviewed Aug 23, 2023

View reviewed changes

hack/tools/release/notes.go Outdated Show resolved Hide resolved

hack/tools/release/notes.go Show resolved Hide resolved

richardcase reviewed Aug 24, 2023

View reviewed changes

hack/tools/release/notes.go Outdated Show resolved Hide resolved

mjlshen force-pushed the missing-notes-sections branch 2 times, most recently from 9289954 to 0736c5a Compare August 24, 2023 19:43

k8s-ci-robot assigned furkatgofurov7 Aug 25, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 25, 2023

mjlshen requested a review from killianmuldoon August 26, 2023 22:20

k8s-ci-robot assigned g-gaston Aug 28, 2023

vincepri reviewed Aug 30, 2023

View reviewed changes

k8s-ci-robot requested a review from vincepri August 30, 2023 16:55

sbueringer reviewed Sep 1, 2023

View reviewed changes

hack/tools/release/notes.go Outdated Show resolved Hide resolved

hack/tools/release/notes.go Outdated Show resolved Hide resolved

hack/tools/release/notes.go Show resolved Hide resolved

🌱 Add additional blocks to release note generation

fe049f2

* An optional header when generating a release candidate * A highlights header with filler to manually replace * An optional header about deprecation warnings Signed-off-by: Michael Shen <mishen@umich.edu>

mjlshen force-pushed the missing-notes-sections branch from 0736c5a to fe049f2 Compare September 1, 2023 14:13

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 1, 2023

k8s-ci-robot requested review from furkatgofurov7 and g-gaston September 1, 2023 14:13

willie-yao approved these changes Sep 1, 2023

View reviewed changes

k8s-ci-robot assigned willie-yao Sep 1, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 1, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 4, 2023

k8s-ci-robot merged commit df024c3 into kubernetes-sigs:main Sep 4, 2023
22 checks passed

k8s-ci-robot added this to the v1.6 milestone Sep 4, 2023

mjlshen deleted the missing-notes-sections branch September 4, 2023 11:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 Add additional blocks to release note generation #9247

🌱 Add additional blocks to release note generation #9247

mjlshen commented Aug 20, 2023 •

edited

mjlshen commented Aug 20, 2023

killianmuldoon left a comment

furkatgofurov7 left a comment

richardcase commented Aug 24, 2023

mjlshen commented Aug 25, 2023

furkatgofurov7 commented Aug 25, 2023

k8s-ci-robot commented Aug 25, 2023

richardcase commented Aug 25, 2023

mjlshen commented Aug 25, 2023 •

edited

g-gaston commented Aug 28, 2023

furkatgofurov7 commented Aug 30, 2023

furkatgofurov7 commented Aug 30, 2023

vincepri Aug 30, 2023

mjlshen Aug 30, 2023

mjlshen commented Sep 1, 2023

sbueringer left a comment

willie-yao left a comment

k8s-ci-robot commented Sep 1, 2023

furkatgofurov7 commented Sep 4, 2023

sbueringer commented Sep 4, 2023

k8s-ci-robot commented Sep 4, 2023

		@@ -73,6 +73,8 @@ var (

		prefixAreaLabel = flag.Bool("prefix-area-label", true, "If enabled, will prefix the area label.")

		preReleaseVersion = flag.Bool("pre-release-version", false, "If enabled, will add a pre-release warning header. (default false)")

🌱 Add additional blocks to release note generation #9247

🌱 Add additional blocks to release note generation #9247

Conversation

mjlshen commented Aug 20, 2023 • edited

mjlshen commented Aug 20, 2023

killianmuldoon left a comment

Choose a reason for hiding this comment

furkatgofurov7 left a comment

Choose a reason for hiding this comment

richardcase commented Aug 24, 2023

mjlshen commented Aug 25, 2023

furkatgofurov7 commented Aug 25, 2023

k8s-ci-robot commented Aug 25, 2023

richardcase commented Aug 25, 2023

mjlshen commented Aug 25, 2023 • edited

g-gaston commented Aug 28, 2023

furkatgofurov7 commented Aug 30, 2023

furkatgofurov7 commented Aug 30, 2023

vincepri Aug 30, 2023

Choose a reason for hiding this comment

mjlshen Aug 30, 2023

Choose a reason for hiding this comment

mjlshen commented Sep 1, 2023

sbueringer left a comment

Choose a reason for hiding this comment

willie-yao left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Sep 1, 2023

furkatgofurov7 commented Sep 4, 2023

sbueringer commented Sep 4, 2023

k8s-ci-robot commented Sep 4, 2023

mjlshen commented Aug 20, 2023 •

edited

mjlshen commented Aug 25, 2023 •

edited