-
Notifications
You must be signed in to change notification settings - Fork 57
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.
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
feat: add release-notes target #1734
Conversation
I will remove this target from #1712. That one is not gonna get merge before release, but would like to use the release notes for 0.17.0, hence this separate PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I usually do it "manually" with Generate release notes
which does a great job including links to PRs, description etc. Outputs that are read by humans shouldn't imho be fully automated, but just leverage technology like "Generate release notes" does, which allows for some human corrections.
I believe @jm-clius also prefered it to be a bit more manual? To do some last minute corrections?
Not a blocker though, just an opinion from someone not in charge of the releases.
Yeah, it will stay manual for now. My plan here is to have a branch and tag with release candidate builds (binaries, container images..) prepped automatically, then have a manual step to review, edit and push final release/tag, but ideally the initial steps of release prep should be automatic. |
@alrevuelta I tried with the Generate release notes and it does not look very good with semantic commits: We can change the format if we need to and still manually edit things as much as we want:) But I personally like the format way more than what |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I previously used the Generate release notes...
but this required a significant amount of manual rewriting. This seems better and more configurable to make the manual intervention a bit less tedious. Good work. :)
@vpavlin thanks, indeed looks better than the github release notes. |
adc6be3
to
cd1edd9
Compare
cd1edd9
to
99261e6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That PR is awesome. Thanks for it!
Description
Adds a make target to generate release notes based on commit messages.
Changes
Example:
$ make release-notes
v0.17.0 (2023-05-16)
Features
...