Skip to content

ci(release): prepend highlights from release-notes/<tag>.md#62

Merged
RealZST merged 1 commit into
mainfrom
ci/release-highlights-from-file
May 15, 2026
Merged

ci(release): prepend highlights from release-notes/<tag>.md#62
RealZST merged 1 commit into
mainfrom
ci/release-highlights-from-file

Conversation

@RealZST
Copy link
Copy Markdown
Owner

@RealZST RealZST commented May 15, 2026

Summary

Make the in-app updater dialog show release Highlights without any manual fix-up after publishing.

Problem: release.yml Generate changelog step builds the body from gh api .../generate-notes, which only produces a PR list β€” no Highlights. Manually editing the GitHub draft body adds them on the release page, but does not write back into latest.json.notes, so the in-app updater dialog stays Highlights-less. v1.4.0 was patched by hand (gh release download latest.json β†’ edit β†’ --clobber upload).

Fix: Have the changelog step look for .github/release-notes/<tag>.md and prepend its contents to the body before writing $GITHUB_OUTPUT. The same body feeds both the draft release (gh api) and tauri-action's releaseBody, so Highlights now appear on the release page and in latest.json.notes automatically.

  • -s test β†’ file missing or empty falls back to existing behavior, no-op for releases without a highlights file
  • Added .github/release-notes/README.md documenting the convention and the full release flow (including the scripts/bump-version.sh step)

Test plan

  • Next release: write .github/release-notes/v<tag>.md, run bump-version.sh, commit, tag, push
  • Verify GitHub release page body has Highlights prepended above the auto PR list
  • curl -L .../latest.json | jq -r .notes contains Highlights
  • In-app Check for Updates dialog shows Highlights
  • Release without a highlights file (any future patch) β€” workflow still produces the auto PR list as before

πŸ€– Generated with Claude Code

The auto-generated PR-list changelog never includes a Highlights
section, and manually editing the GitHub draft release body only
updates the release page β€” it does not write back into latest.json's
notes field, so the in-app updater dialog stays empty of highlights.

Have the Generate changelog step look for a hand-written
.github/release-notes/<tag>.md and prepend its contents to the body
before writing $GITHUB_OUTPUT. The same body feeds both the draft
release (gh api) and tauri-action's releaseBody, so highlights now
appear in both surfaces automatically.

File missing or empty (-s test) falls back to existing behavior, so
this is a no-op for any release that doesn't author a highlights file.

Add a README under .github/release-notes/ documenting the convention
and the full release flow.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@RealZST RealZST force-pushed the ci/release-highlights-from-file branch from fcc7f90 to d4bf568 Compare May 15, 2026 16:51
@RealZST RealZST merged commit d034a8a into main May 15, 2026
3 checks passed
@RealZST RealZST deleted the ci/release-highlights-from-file branch May 15, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant