Fix CHANGELOG line ending preservation in Prepare Release workflow#687
Merged
YunchuWang merged 2 commits intomainfrom Mar 24, 2026
Merged
Fix CHANGELOG line ending preservation in Prepare Release workflow#687YunchuWang merged 2 commits intomainfrom
YunchuWang merged 2 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the “Prepare Release” GitHub Actions workflow to avoid rewriting CHANGELOG.md with different line endings when the workflow runs on Linux, preventing noisy diffs during release preparation.
Changes:
- Read and write
CHANGELOG.mdusingnewline=''to preserve existing line endings. - Detect the file’s EOL style (CRLF vs LF) and use it when generating the inserted version section.
kaibocai
approved these changes
Mar 24, 2026
kaibocai
approved these changes
Mar 24, 2026
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
What changed?
prepare-release.yamlto preserve original line endings (CRLF) when updatingCHANGELOG.md.Why is this change needed?
CHANGELOG.mdappeared changed because the Python script on the Linux runner stripped\r(CRLF → LF) when reading/writing the file.newline=''inopen()calls to preserve original line endings, and auto-detects the EOL style for inserted content.Issues / work items
Project checklist
AI-assisted code disclosure (required)
Was an AI tool used? (select one)
If AI was used:
.github/workflows/prepare-release.yamlAI verification (required if AI was used):