MNT: Add tool for generating GitHub-friendly release notes from RST changelog #1284
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
|
See it in action: https://github.com/nipy/nibabel/releases/tag/5.2.0 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1284 +/- ##
==========================================
- Coverage 92.27% 92.24% -0.03%
==========================================
Files 99 99
Lines 12459 12459
Branches 2561 2561
==========================================
- Hits 11496 11493 -3
- Misses 640 643 +3
Partials 323 323 ☔ View full report in Codecov by Sentry. |
effigies
added a commit
that referenced
this pull request
Feb 27, 2024
DOC: Fix references in changelog MNT: Add tool for generating GitHub-friendly release notes MNT: Avoid isort version with broken extras
effigies
added a commit
that referenced
this pull request
Feb 27, 2024
5.2.1 (Monday 26 February 2024) Bug-fix release in the 5.2.x series. Enhancements ------------ * Support "flat" ASCII-encoded GIFTI DataArrays (pr/1298) (PM, reviewed by CM) Bug fixes --------- * Tolerate missing ``git`` when reporting version info (pr/1286) (CM, reviewed by Yuri Victorovich) * Handle Siemens XA30 derived DWI DICOMs (pr/1296) (CM, reviewed by YOH and Mathias Goncalves) Maintenance ----------- * Add tool for generating GitHub-friendly release notes (pr/1284) (CM) * Accommodate pytest 8 changes (pr/1297) (CM) * tag '5.2.1': REL: 5.2.1 Backport gh-1296: Conditionally drop derived volumes from DWI sequences Backport gh-1298: Support "flat" ASCII-encoded GIFTI DataArrays Build(deps): Bump codecov/codecov-action from 3 to 4 Build(deps): Bump the actions-infrastructure group with 3 updates Backport gh-1297: Accommodate pytest 8 changes Backport gh-1286: Tolerate missing git MNT: Advertise Python 3.12 support DOC: Fix intersphinx mapping and reference type Backport gh-1284: Add tool for generating GitHub-friendly release notes
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.
GitHub releases don't automatically convert RST to Markdown, so a direct copy ends up with warts, such as too many line breaks in the rendered output and unlinked references.
This PR fixes the former, mostly, and implements an extremely basic dereferencer. I also replace
pr/...with#...to link to PRs.This will probably need minor updates with each release, but it's a good starting point and should save time overall.