Fix zizmor warning in release workflow #2826
Merged
Conversation
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
adamtheturtle
temporarily deployed
to
development
GitHub Actions
Inactive
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| replace: "Next\n----\n\n${{ steps.calver.outputs.release }}\n${{ steps.changelog_underline.outputs.underline\ | ||
| \ }}" | ||
| replace: |- | ||
| Next\n----\n\n${{ steps.calver.outputs.release }}\n${{ steps.changelog_underline.outputs.underline }}\n |
There was a problem hiding this comment.
Block scalar preserves literal \n instead of newlines
The change from a double-quoted string to a YAML literal block scalar (|-) breaks the newline handling. In double-quoted strings, \n is interpreted as a newline character, but in literal block scalars, \n is preserved as the literal two characters backslash and 'n'. The find field still uses a double-quoted string with actual newlines, but the replace field will now insert literal \n text instead of line breaks, corrupting the CHANGELOG.rst file format when the release workflow runs.
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.
Use YAML block scalar syntax for replace field to fix zizmor warning.
Note
Workflow update
release.yml, changes thegha-find-replacereplacevalue to a YAML block scalar (|-) and adds an explicit trailing newline for the changelog insertion.Written by Cursor Bugbot for commit 2ed976c. This will update automatically on new commits. Configure here.