-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[DX Streamline] Use the mkreleaselog generated changelog when creating GitHub Releases #12162
Comments
Note, example of running locally:
Compared to changelog: It looks like we have to
|
Also remove merge commits. We could also completely re-do this; while consistency is nice, there are tools out there that can do a better job for us. I wrote https://github.com/nodejs/changelog-maker eons ago and it's still used today for Node.js releases (I still use it, and its friend https://github.com/nodejs/branch-diff, to do git wrangling); although it's tuned for linear commit histories and will probably have some trouble with the heavy merge action that happens in lotus. But there are others. Or, we can accept a less human-curated output format and not worry too much about it - people will just scan these anyway. Or, we could use the tooling for a first-pass and then make the human do some curation before finalisation: one of the final steps being to go into the auto-generated CHANGELOG and (a) confirm it and (b) tinker with it to make it pretty. |
Agreed, note that with #12069 contributors will start adding to changelogs with every PR; generated changelog lines might be duplicate / not relevant now that we have editorialized changes descriptions. I would recommend "just" pulling the changes from submodules (like github.com/filecoin-project/go-state-types in the example), and the list of contributors. |
Problem to solve
When a GitHub Release of lotus is created, it contains an auto-generated changelog. Then, a release performer has to update the release description manually to reflect the mkrelease log outputs (and CHANGELOG.md) contents. This should be automated.
Why Important
There is no good reason to put the demand of running a script and copying its' outputs on a human. Computers are capable of doing that.
User/Customer
Lotus maintainers
Notes
Enabled by #12096
The text was updated successfully, but these errors were encountered: