[PR #124] [MERGED] [ci] Fix GitHub Release step breaking on quotes in release notes #129

New issue

Closed

opened 2026-10-13 19:47:42 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-13 19:47:42 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Glitchy-Sheep/boosty-downloader/pull/124
Author: @Glitchy-Sheep
Created: 8/9/2026
Status: ✅ Merged
Merged: 8/9/2026
Merged by: @Glitchy-Sheep

Base: main ← Head: fix/release-notes-quoting

📝 Commits (1)

c192849 fix: 🐛 Release notes with quotes no longer break the GitHub Release step

📊 Changes

1 file changed (+6 additions, -6 deletions)

View changed files

📝 .github/workflows/release.yaml (+6 -6)

📄 Description

Summary

The v3.1.0 release published the package to PyPI but failed at the last step - creating the GitHub Release page. This PR makes that step survive any changelog content.

Problem

The Create GitHub Release step pasted the changelog into the shell script through ${{ steps.changelog.outputs.body }}
GitHub Actions expands ${{ }} as plain text before bash parses the script
The v3.1.0 notes contain double quotes (clear "Missing option" error), so the first quote closed the --notes "..." string
The rest of the notes became stray arguments, gh release create read them as asset paths and failed with no matches found
Earlier releases passed only because their notes had no quotes

Fix

The extract step now writes the changelog section to release-notes.md and prints it into the job log
gh release create reads it with --notes-file
No changelog text is pasted into the script anymore, so no character in it can break the shell

Before / After

Before: a release fails at the last step when the changelog contains a double quote.
After: any changelog content ships as release notes unchanged.

Verification

The v3.1.0 GitHub Release was created manually with the same --notes-file approach and the same quoted notes - worked on the first try

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Glitchy-Sheep/boosty-downloader/pull/124 **Author:** [@Glitchy-Sheep](https://github.com/Glitchy-Sheep) **Created:** 8/9/2026 **Status:** ✅ Merged **Merged:** 8/9/2026 **Merged by:** [@Glitchy-Sheep](https://github.com/Glitchy-Sheep) **Base:** `main` ← **Head:** `fix/release-notes-quoting` --- ### 📝 Commits (1) - [`c192849`](https://github.com/Glitchy-Sheep/boosty-downloader/commit/c1928496240d926433bc14ac13b3b9263f177138) fix: :bug: Release notes with quotes no longer break the GitHub Release step ### 📊 Changes **1 file changed** (+6 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/release.yaml` (+6 -6) </details> ### 📄 Description ## Summary The v3.1.0 release published the package to PyPI but failed at the last step - creating the GitHub Release page. This PR makes that step survive any changelog content. ## Problem - The `Create GitHub Release` step pasted the changelog into the shell script through `${{ steps.changelog.outputs.body }}` - GitHub Actions expands `${{ }}` as plain text before bash parses the script - The v3.1.0 notes contain double quotes (`clear "Missing option" error`), so the first quote closed the `--notes "..."` string - The rest of the notes became stray arguments, `gh release create` read them as asset paths and failed with `no matches found` - Earlier releases passed only because their notes had no quotes ## Fix - The extract step now writes the changelog section to `release-notes.md` and prints it into the job log - `gh release create` reads it with `--notes-file` - No changelog text is pasted into the script anymore, so no character in it can break the shell ## Before / After **Before:** a release fails at the last step when the changelog contains a double quote. **After:** any changelog content ships as release notes unchanged. ## Verification - The v3.1.0 GitHub Release was created manually with the same `--notes-file` approach and the same quoted notes - worked on the first try --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-13 19:47:42 +00:00