Skip to content

Commit cac2b74

Browse files
author
Release Manager
committed
gh-39288: Fix the new release workflow by escaping special characters <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> The new release creation workflow introduced by #39194 failed for the latest release: https://github.com/sagemath/sage/actions/runs/12612595224/job/3514974517 9 with the message "Problems parsing JSON". See the "Create release" step. Reported by passagemath/passagemath#638 We fix it by escaping special characters in `release_notes` for json input. test: https://github.com/kwankyu/sage/releases/tag/10.7.beta3 test workflow run: https://github.com/kwankyu/sage/actions/runs/12620257460/job/35165981375 ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #39288 Reported by: Kwankyu Lee Reviewer(s): Soham Rane
2 parents 2ff22f9 + cf878ac commit cac2b74

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

.github/workflows/dist.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@ jobs:
135135
\"tag_name\": \"${{ github.ref_name }}\",
136136
\"previous_tag_name\": \"$latest_release_tag\"
137137
}" | jq -r '.body')
138+
# escape special characters for json
139+
release_notes=$(jq -R -s '.' <<< "$release_notes")
138140
curl -L \
139141
-X POST \
140142
-H "Accept: application/vnd.github+json" \
@@ -144,7 +146,7 @@ jobs:
144146
-d "{
145147
\"tag_name\": \"${{ github.ref_name }}\",
146148
\"prerelease\": ${{ contains(github.ref, 'beta') || contains(github.ref, 'rc') }},
147-
\"body\": \"$release_notes\"
149+
\"body\": $release_notes
148150
}"
149151
- name: Create release assets
150152
uses: softprops/action-gh-release@v2

0 commit comments

Comments
 (0)