-
Notifications
You must be signed in to change notification settings - Fork 573
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
rfc: simplify changelog process #8772
Conversation
I am very much for this new process. The current process is a pain. 👍🏾👍🏾👍🏾👍🏾 |
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.
Love it! 👏 thanks Brian
Co-authored-by: Dima Tretyak <[email protected]>
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.
Makes sense to me to do this if we are not planning on investing resources to wrap up the initial plan. Thanks Brian for making this effort
thanks for all the feedback! merging! let me know if anyone runs into issues! |
This PR is also an RFC to simplify our changelog process.
The Current Process
We have an open PR that is being automatically updated periodically: https://github.com/artsy/eigen/pull/8135/files in theory with changes from most recent release. It looks for the last submission tag and parses our changelog messages out of the commits since that tag. Release captains then check this PR for relevant changes.
In practice this has been a little problematic:
All of these are solvable problems but I propose just simplifying a bit because I think the benefit of all this automation isn't actually worth the complexity.
Proposed process
When release captains are preparing for a release they run a changelog script locally with the target submission tag and the last submission tag. This will output something similar to this:
Release captains then paste that in the QA doc and use it going forward for release notes.
Later maybe we can decide to commit this back each release for now I propose just keeping it simple as you can always just run the script again with the same tags.
If Accepted