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

Refactors Release workflow to use a YAML block scalar for the changelog update.

  • In release.yml, changes gha-find-replace replace value to a block scalar (|-) to correctly inject the version and underline with a trailing newline when updating CHANGELOG.rst

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

@adamtheturtle adamtheturtle enabled auto-merge (squash) January 3, 2026 08:52
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 doesn't interpret \n as newline characters

The change from double-quoted string to YAML block scalar (|-) syntax breaks the replacement. In double-quoted strings, \n is interpreted as a newline character. In literal block scalars, \n is kept as literal backslash-n text. The find pattern on line 60 still uses double-quoted syntax (actual newlines), but the replace content now contains literal \n characters instead of newlines. This will insert malformed text into CHANGELOG.rst instead of properly formatted lines.

Fix in Cursor Fix in Web

@adamtheturtle adamtheturtle merged commit 4cded4c 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