Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🌱 Add additional blocks to release note generation #9247

Merged
merged 1 commit into from
Sep 4, 2023
Merged

🌱 Add additional blocks to release note generation #9247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 22 additions & 1 deletion hack/tools/release/notes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ var (

prefixAreaLabel = flag.Bool("prefix-area-label", true, "If enabled, will prefix the area label.")
mjlshen marked this conversation as resolved.
Show resolved Hide resolved

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

deprecation = flag.Bool("deprecation", true, "If enabled, will add a templated deprecation warning header.")
addKubernetesVersionSupport = flag.Bool("add-kubernetes-version-support", true, "If enabled, will add the Kubernetes version support header.")

tagRegex = regexp.MustCompile(`^\[release-[\w-\.]*\]`)
Expand Down Expand Up @@ -307,15 +309,34 @@ func run() int {
}
}

if *preReleaseVersion {
fmt.Printf("🚨 This is a RELEASE CANDIDATE. Use it only for testing purposes. If you find any bugs, file an [issue](https://github.com/%s/issues/new).\n", *repo)
}

if *addKubernetesVersionSupport {
// TODO Turn this into a link (requires knowing the project name + organization)
mjlshen marked this conversation as resolved.
Show resolved Hide resolved
fmt.Print(`## 👌 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)

`)
}

fmt.Print(`## Highlights

* REPLACE ME

`)

if *deprecation {
fmt.Print(`## Deprecation Warning

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

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

`)
}

Expand Down