Skip to content

fix(release): unbreak install-note step and auto-publish drafts#67

Merged
aicayzer merged 1 commit into
mainfrom
fix/release-workflow-heredoc
May 18, 2026
Merged

fix(release): unbreak install-note step and auto-publish drafts#67
aicayzer merged 1 commit into
mainfrom
fix/release-workflow-heredoc

Conversation

@aicayzer
Copy link
Copy Markdown
Owner

Summary

Two fixes to .github/workflows/release.yml, both surfaced by the v0.3.0 release:

  • The install-note heredoc contained don't. Inside the surrounding NOTE=$(cat <<EOF ... EOF) command substitution, bash interprets the apostrophe as an unmatched single quote, failing the step with unexpected EOF while looking for matching '. Reword to do not.
  • electron-builder's default releaseType is draft, so even with the install-note step working, the release stayed as a draft and had to be promoted manually. Add gh release edit "$TAG" --draft=false so future releases auto-publish.

Why now

v0.3.0 hit both: the install-note step failed, and the release was a draft. I fixed both manually on the v0.3.0 release. This PR makes future tag pushes work end-to-end without intervention.

Test plan

  • YAML lints cleanly (no schema errors)
  • Verify on next release that the install note appears and the release is published automatically (deferred to v0.3.1+ — no point cutting one just to test)

Two fixes to the release workflow, both surfaced by the v0.3.0 release:

1. The heredoc that builds the install-note text contained the word
   `don't`. Inside the `NOTE=$(cat <<EOF ... EOF)` command substitution
   bash treats the apostrophe as an unmatched single quote, failing
   the step with `unexpected EOF while looking for matching '`. Reword
   to `do not` — minimal-blast-radius fix; no need to switch heredoc
   styles.

2. electron-builder's default `releaseType` is `draft`, so even after
   the install note is appended the release stays as a draft. v0.3.0
   had to be promoted to published manually. Add an explicit
   `gh release edit "$TAG" --draft=false` so future releases auto-publish.
@aicayzer aicayzer merged commit 84f7b41 into main May 18, 2026
3 checks passed
@aicayzer aicayzer deleted the fix/release-workflow-heredoc branch May 18, 2026 16:14
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