1-step release action #366
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #366 +/- ##
==========================================
- Coverage 96.03% 95.99% -0.04%
==========================================
Files 31 31
Lines 4211 4396 +185
Branches 642 668 +26
==========================================
+ Hits 4044 4220 +176
- Misses 95 99 +4
- Partials 72 77 +5 ☔ View full report in Codecov by Sentry. |
Now this script can be used in the following ways: - without "--replace" argument the new CHANGELOG is printed to stdout - If there is Unreleased content and the requested tag already exists right after Unreleased, we assume that a failed release is being fixed. Content from Unreleased is moved into that section and appended to what is already there. - If the tags match but there are no Unreleased changelog notes, nothing much should change. (Maybe some line breaks.) This might be the case if we are on a release branch and already manually updated the CHANGELOG. - Otherwise, we create a new release section under Unreleased, move content from Unreleased into that section, and update the "compare" links. While working on the parser I ran into a broken link and some inconsistent spacing in the existing CHANGELOG.rst file.
This could be done in a _slightly_ more modular fashion but would add a bit of complexity as well to pass around the file changes across actions without making multiple commits in the history. The nice thing about this setup is that bump_changelog.py doesn't mind at all if you already sorted out the CHANGELOG by hand, so if there are any difficult/edge cases they can be handled by using a release branch and running the script locally before using the release action.
itertools.batched is from Python 3.12. Not a complete dealbreaker, but makes life simpler as developers are likely running the script from a Euphonic dev environment which is 3.10 with toolz available.
be48b28 to
ce313a7
Compare
|
Move to #368 to avoid annoying duplicate test triggers due to "release" branch name. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #326