Skip to content

Friendly, dual-audience release notes#66

Merged
nicglazkov merged 1 commit into
mainfrom
ci/friendly-release-notes
Jul 16, 2026
Merged

Friendly, dual-audience release notes#66
nicglazkov merged 1 commit into
mainfrom
ci/friendly-release-notes

Conversation

@nicglazkov

Copy link
Copy Markdown
Owner

What

Rewrites how GitHub Releases read so they work for both non-technical users and developers.

Before: every release was a raw --generate-notes dump (40+ lines of feat(...)/chore(deps): Bump ... PR titles), with no explanation of what the app is or how to install it.

After: each release opens with a one-sentence description, numbered Android install steps, and a plain-language What's new summary. The full commit-level changelog is preserved for developers inside a collapsible <details> block.

How

  • .github/release-body-header.md holds the static intro + install section (reused every release).
  • The workflow composes the body: header + a one-line highlight from the annotated tag's subject (git tag -a vX -m "...") + the auto-generated changelog, collapsed.
  • The three existing releases (v0.1.0-v0.1.2) were already rewritten to match.

No em dashes, no emoji, consistent with the README.

Every tagged release now gets a plain-language intro and Android install
steps (from .github/release-body-header.md), a one-line 'What's new' summary
taken from the annotated tag's subject, and the full commit-level changelog
tucked into a collapsible section for developers. Replaces the raw
--generate-notes dump that non-technical users saw before.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014xbfpFLSceHGbpCVz2qBGG
@nicglazkov
nicglazkov merged commit cea3a71 into main Jul 16, 2026
3 checks passed
@nicglazkov
nicglazkov deleted the ci/friendly-release-notes branch July 16, 2026 09:07
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