Fix zizmor warning in release workflow #1483
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 doesn't interpret \n as newline characters
The change from a double-quoted string to a literal block scalar (|-) breaks escape sequence processing. In the original double-quoted string, \n was interpreted as actual newlines. With |-, the \n sequences become literal backslash-n characters. Since find still uses a double-quoted string where \n means newline, the replacement will insert literal \n text into CHANGELOG.rst instead of actual line breaks, corrupting the file formatting.
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
Updates the release workflow to use a YAML block scalar for the
gha-find-replacereplacevalue inrelease.yml.replaceto a block scalar that inserts the computed version header and underline with a trailing newline when updatingCHANGELOG.rstWritten by Cursor Bugbot for commit 809bf10. This will update automatically on new commits. Configure here.