Skip to content

Conversation

@adamtheturtle
Copy link
Member

@adamtheturtle adamtheturtle commented Jan 3, 2026

Use YAML block scalar syntax for replace field to fix zizmor warning.


Note

Refines the release workflow to correctly handle a multi-line replacement when updating CHANGELOG.rst.

  • In .github/workflows/release.yml, changes the gha-find-replace replace field to a YAML block scalar, preserving newlines (Next\n----\n\n...\n) in the inserted changelog header

Written by Cursor Bugbot for commit d06536e. This will update automatically on new commits. Configure here.

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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Block scalar makes \n literal instead of newlines

The YAML block scalar syntax (|-) treats \n as literal backslash-n characters instead of actual newlines. The original double-quoted string correctly interpreted \n as newline characters. This will cause the changelog to have literal \n text inserted instead of proper line breaks, breaking the changelog formatting.

Fix in Cursor Fix in Web

@adamtheturtle adamtheturtle merged commit 755c3c4 into main Jan 3, 2026
10 checks passed
@adamtheturtle adamtheturtle deleted the fix-zizmor-warning branch January 3, 2026 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants