-
Notifications
You must be signed in to change notification settings - Fork 411
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
Replace outdated changelog #332
Conversation
Codecov Report
@@ Coverage Diff @@
## master #332 +/- ##
==========================================
+ Coverage 69.68% 69.73% +0.04%
==========================================
Files 28 28
Lines 2421 2415 -6
==========================================
- Hits 1687 1684 -3
+ Misses 616 613 -3
Partials 118 118
|
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 for auto gen.
Two comments:
- We need to be extra careful with the names of issues or prs, so the title makes sense without more context.
- Some items (eg closed issues as "will not do") should not appear here. Maybe you can generate the log with the tool, and then do a bit of hand sanitizing, to remove noise.
Agree that we should be more sensible with titles. Hand sanitizing would not work as it always generates the full changelog and not only the diff to the last commit. But with a better use of labels we can have this covered as well:
There is one behaviour that we need to consider in the workflow: the v0.13.0 section can only be generated when the tag was set. In order to have a proper changelog, we need to generate it at the latest before we tag, then set the tag and generate again after the tag. The PR to close an issue will not contain the changelog for it.... 🤔 |
I have gone through the closed issues without a PR and assigned exclusion labels before regenerating. |
Thank you for the explanation and it sounds good.
Looks like we need some time traveling circular dependencies here. 👍 What about.
|
🤔 the generated doc seems not to be deterministic. I got a different file for every run now on the same codebase. |
It worked better with an docker image: |
Cropped everything before v0.12.0 I think some best practice to use labels for better semantic makes sense. But as discussed on internal discord, I would go with a manual changelog in the future and use the generator before a release to collect the data and double check. |
Resolves #331
Generated with
https://github.com/github-changelog-generator/github-changelog-generator