Skip to content

Commit

Permalink
sagemathgh-39288: Fix the new release workflow by escaping special ch…
Browse files Browse the repository at this point in the history
…aracters

    
<!-- ^ 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 sagemath#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 sagemath#12345". -->

The new release creation workflow introduced by
sagemath#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,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#39288
Reported by: Kwankyu Lee
Reviewer(s): Soham Rane
  • Loading branch information
Release Manager committed Jan 8, 2025
2 parents 86cdd22 + cf878ac commit 471effb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/workflows/dist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ jobs:
\"tag_name\": \"${{ github.ref_name }}\",
\"previous_tag_name\": \"$latest_release_tag\"
}" | jq -r '.body')
# escape special characters for json
release_notes=$(jq -R -s '.' <<< "$release_notes")
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
Expand All @@ -144,7 +146,7 @@ jobs:
-d "{
\"tag_name\": \"${{ github.ref_name }}\",
\"prerelease\": ${{ contains(github.ref, 'beta') || contains(github.ref, 'rc') }},
\"body\": \"$release_notes\"
\"body\": $release_notes
}"
- name: Create release assets
uses: softprops/action-gh-release@v2
Expand Down

0 comments on commit 471effb

Please sign in to comment.