-
Notifications
You must be signed in to change notification settings - Fork 784
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
Added changelog generator script and configuration. #289
Conversation
The changelog up to today looks as below. I find placing the PRs nice because they give explicit credit to the contributors, but we can also trim them. @ianmcook , do you think the content below would be a sufficient form of documentation about what changed? For older versions, see apache/arrow/CHANGELOG.md Changelog4.0.1 (2021-05-14)Implemented enhancements:
Fixed bugs:
Documentation updates:
Merged pull requests:
* This Changelog was automatically generated by github_changelog_generator |
Codecov Report
@@ Coverage Diff @@
## master #289 +/- ##
=======================================
Coverage 82.49% 82.49%
=======================================
Files 162 162
Lines 43980 43980
=======================================
+ Hits 36282 36283 +1
+ Misses 7698 7697 -1
Continue to review full report at Codecov.
|
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.
Looks very cool @jorgecarleitao
I ran CHANGELOG_GITHUB_TOKEN=$ARROW_GITHUB_API_TOKEN ./change_log.sh
locally
It all seemed to go well until the end:
Generated log placed in /usr/local/src/your-app/CHANGELOG.md
sed: 1: "CHANGELOG.md": invalid command code C
I think as we gear up for our first release (🎉 ) of code from arrow-rs, we should start documenting some processes. For example, maybe we could write up a few words about how to make release notes in https://github.com/apache/arrow-rs/blob/master/dev/README.md
--project arrow-rs \ | ||
--since-commit 2021-04-20 \ | ||
--future-release 4.0.1 | ||
sed -i "s/\\\n/\n\n/" CHANGELOG.md |
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 wonder if this should be something like
sed -i "s/\\\n/\n\n/" CHANGELOG.md | |
sed -i -e "s/\\\n/\n\n/" CHANGELOG.md |
Though I am not a sed
🧙
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.
This was due to a bug on the generator, github-changelog-generator/github-changelog-generator#962, that it was fixed and released in less than 24h (big kudos to @olleolleolle for this 💯 ). I need to check that the new docker image works as intended, so that we can remove this hack. 👍
I plan to merge this in once I can get a clean PR run - and then I will use it to create part of the initial proposed 4.0.1 release |
sounds good. I agree that a dry-run over a concrete release helps flushing out any issues around this 👍 |
Closes #274