fix: normalize changelog markdown output and pin docs to v2.0.1#7
Merged
Conversation
The • character is not standard markdown list syntax, so consecutive bullet lines were rendered inline in previews. Add a post-processing step that inserts blank lines around ## headings and appends two trailing spaces (markdown hard break) to every bullet line.
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
1 participant
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.
Summary
This PR fixes changelog markdown formatting so bullet entries render as separate lines in GitHub previews and keeps the documentation aligned with the current action tag. It adds a normalization step to generated changelogs and updates usage examples to reference
v2.0.1.Changes
Changelog formatting
scripts/normalize_changelog.pyto normalize heading spacing and force bullet lines to render on separate linesCHANGELOG.mdDocumentation
README.mdaction usage examples to referenceWaveful/ChangelogAction@v2.0.1.gitignorefor local test artifactsTest plan
python3 -m unittest tests/test_normalize_changelog.pyv2.0.1action usage