antrea-io / antrea

Kubernetes networking based on Open vSwitch
https://antrea.io
Apache License 2.0
1.67k stars 367 forks source link

Consider auto-generating CHANGELOG for release based on PR descriptions #2411

Open antoninbas opened 3 years ago

antoninbas commented 3 years ago

Describe what you are trying to solve In https://github.com/antrea-io/antrea/pull/2230#discussion_r643608440, @tnqn suggested that we try to automate CHANGELOG-generation for each release, by collecting the relevant information from PR descriptions.

This is a good idea that would significantly simplify the release process in the long term, especially if the project keeps growing or if the release cadence slows down over time.

Describe the solution you have in mind

Note that this may require more consistent labelling of PRs (notably the kind/* label and the release milestone) in order to generate high-quality release notes.

Describe how your solution impacts user flows Users are not impacted. Contributors are expected to generate the CHANGELOG entry for their contribution. Release process is simplified for maintainers.

Additional context K8s has tooling to auto-generate release notes. It is possible that we can re-use some of it with some small changes: https://github.com/kubernetes/release

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment, or this will be closed in 90 days