Refactor CHANGELOG template to use printf for better formatting#152
Merged
Refactor CHANGELOG template to use printf for better formatting#152
Conversation
The multi-line bash string for UNRELEASED_TEMPLATE had content starting at column 0, which broke YAML literal block parsing. Using printf to build the template keeps proper YAML indentation.
There was a problem hiding this comment.
Pull request overview
This PR refactors the CHANGELOG template generation in the create-release workflow from a multi-line string literal to a printf-based approach. The change improves code consistency and maintainability while producing identical output.
Changes:
- Replaced multi-line string literal with
printfcommand for constructing UNRELEASED_TEMPLATE - Uses explicit
%s\n\nformat specifiers to clearly define spacing between sections - Maintains identical output with improved readability and reduced whitespace ambiguity
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
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.
Summary
Refactored the
UNRELEASED_TEMPLATEvariable in the create-release workflow to useprintfinstead of a multi-line string literal. This improves code consistency and maintainability.Changes
printfcommand for constructing the CHANGELOG template%s\n\nformat specifier to properly handle newlines and spacing between sectionsImplementation Details
The new approach using
printfwith explicit format specifiers is more robust for shell scripting as it: