-
Notifications
You must be signed in to change notification settings - Fork 58
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
Generate automatic CHANGELOG from release note and add it to docs #684
Conversation
One question- will the release notes for the current release appear in that release's changelog file, or will it show up in the next release? |
I'm not sure. Let me check what action will run this workflow. If is the later, do you think we can add your changelog from here and use the changes of this PR for future releases? |
We can definitely build the changelog from old releases manually. I'm more concerned that each release might be missing its own release notes. So if you went to the RTD build for v0.20.0, you would only see a changelog covering v0.0.1-v0.19.0, without the changes that went into v0.20.0. |
Codecov Report
@@ Coverage Diff @@
## main #684 +/- ##
=======================================
Coverage 85.32% 85.32%
=======================================
Files 41 41
Lines 4503 4503
=======================================
Hits 3842 3842
Misses 661 661 Continue to review full report at Codecov.
|
I wasn't able to test this workflow or automatically add previous release notes in this PR because the CHANGELOG.md does not exist in the neurostuff:main and JulioAPeraza:auto-changelog doesn't contain releases. Would it be OK to test this in a separate PR after this one is merged? |
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'm happy to test it on main
and then fix it up in a later PR if necessary. I'll merge this now.
We can make an rc release this week to test it.
Closes #603 .
Changes proposed in this pull request: