Repository navigation
Format release notes with Snapper after Towncrier - #1978
Merged
Merged
Conversation
adamtheturtle
changed the title
This branch was successfully deployed
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.
The release workflow currently commits Towncrier's generated Markdown before Snapper formats it. The resulting changelog can fail the semantic line break checks on main and on later PRs.
Run Snapper immediately after Towncrier and before copying the changelog into
release-notes.md. The committed changelog and GitHub release body therefore use the same formatted content. This uses the same Snapper version and command flags as the semantic-line-breaks workflow. Towncrier keeps its default template and existing heading configuration.Validation: generated release notes through
towncrier build --yesin a temporary Git repository with 7 current, historical, and edge-case fragments; formatted with Snapper 0.11.9; confirmed Snapper's check passes and the copied release notes are byte-identical. Actionlint, applicable YAML formatting checks, andgit diff --checkpassed. The intended change is confined to the release workflow.Also formats the existing changelog with the same Snapper settings so the current release notes pass CI. Checked all tracked Markdown changelog files with the pinned Snapper version.