Repository navigation
Fix release-note extraction and Markdown conversion - #330
Merged
Merged
Conversation
Preserve indentation when extracting a release section so multi-line RST bullets stay intact, shift headings instead of promoting the lone section heading to a document title, and fix malformed RST links in the Spack note. Co-authored-by: Copilot <[email protected]> Copilot-Session: 3eaf20ea-3ac0-4701-958f-28527bf641fc
This file contains hidden or 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
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.
The v3.5.0 GitHub release notes were garbled: most bullets ran together into one paragraph, and "Minor Updates" became YAML front matter.
Causes:
.extract_section.shusedwhile read line, which strips leading whitespace, so continuation lines of multi-line RST bullets lost their indentation and ended the list.pandoc --standalonepromoted the only section heading to a document title.docs/releases.rsthad malformed RST link syntax.Changes:
while IFS= read -r linein.extract_section.sh.--standalonewith--shift-heading-level-by=1, so section headings become##headings.Locally, the 3.5.0 section now converts to 11 Markdown bullets matching the 11 RST bullets, and the 3.4.1 section keeps its three headings.
After merge, the published v3.5.0 release notes can be regenerated and updated with
gh release edit.