Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the new release workflow by escaping special characters #39288

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Jan 5, 2025

The new release creation workflow introduced by #39194 failed for the latest release:

https://github.com/sagemath/sage/actions/runs/12612595224/job/35149745179

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

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • 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

@kwankyu kwankyu changed the title Escape specials characters in release notes Fix new release workflow by escaping specials characters in release_notes Jan 5, 2025
@kwankyu kwankyu changed the title Fix new release workflow by escaping specials characters in release_notes Fix the new release workflow by escaping specials characters Jan 5, 2025
@kwankyu kwankyu marked this pull request as ready for review January 5, 2025 14:45
@kwankyu
Copy link
Collaborator Author

kwankyu commented Jan 5, 2025

@soham30rane would you review?

Copy link
Contributor

@soham30rane soham30rane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, Thanks!

Copy link

github-actions bot commented Jan 5, 2025

Documentation preview for this PR (built with commit cf878ac; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@kwankyu kwankyu changed the title Fix the new release workflow by escaping specials characters Fix the new release workflow by escaping special characters Jan 5, 2025
@kwankyu
Copy link
Collaborator Author

kwankyu commented Jan 5, 2025

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 7, 2025
…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
vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 9, 2025
…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
vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 10, 2025
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants