Skip to content
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

MNT: Add tool for generating GitHub-friendly release notes from RST changelog #1284

Merged
merged 3 commits into from
Dec 12, 2023

Conversation

effigies
Copy link
Member

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.

@effigies
Copy link
Member Author

Copy link

codecov bot commented Dec 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (70795b0) 92.27% compared to head (33363bf) 92.24%.

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.
📢 Have feedback on the report? Share it here.

@effigies effigies merged commit 26a9886 into nipy:master Dec 12, 2023
51 of 52 checks passed
@effigies effigies deleted the doc/release-notes branch December 12, 2023 15:15
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant