Skip to content

feat: add git-cliff changelog generation to release workflow#94

Merged
pfeerick merged 1 commit intomainfrom
feat/changelog-generation
Apr 23, 2026
Merged

feat: add git-cliff changelog generation to release workflow#94
pfeerick merged 1 commit intomainfrom
feat/changelog-generation

Conversation

@pfeerick
Copy link
Copy Markdown
Member

Summary

  • Adds a new generate-changelog job to build_release.yml that installs git-cliff and generates a changelog from the previous latest tag to HEAD
  • Both the upload (Latest Themes Package) and upload-individual (Individual Theme Packages) release jobs now receive the changelog as their release body, so GitHub releases show what changed since the last push
  • Adds cliff.toml at the repo root configuring conventional-commit parsing with groups suited to this repo: Features, Bug Fixes, Documentation, CI/CD, Chores, and Other

How it works

  1. Before the latest tag is force-pushed, the job resolves the commit SHA it currently points to
  2. git-cliff generates a changelog over the range <prev-sha>..HEAD (full history on first run when no latest tag exists yet)
  3. The changelog is passed via job outputs to both upload jobs and injected as the body field on softprops/action-gh-release

Reviewer notes

  • The generate-changelog job is gated with if: github.event_name != 'pull_request' — it won't run on PRs
  • git-cliff is fetched at runtime (latest release) using the same wget pattern as EdgeTX/edgetx's release-drafter.yml
  • Conventional commits in this repo already include PR numbers (e.g. feat: add theme (#93)) so they appear naturally in the changelog body
  • Commits that don't match any conventional-commit prefix fall into the 📦 Other group rather than being dropped

🤖 Generated with Claude Code

Adds a `generate-changelog` job that runs git-cliff between the previous
`latest` tag and HEAD, outputting grouped conventional-commit release notes
into both the `latest` and `individual-themes` GitHub release bodies.

Also adds `cliff.toml` with commit groups suited to this themes repository.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@pfeerick pfeerick force-pushed the feat/changelog-generation branch from f194a7a to 1a24171 Compare April 23, 2026 04:42
@pfeerick pfeerick merged commit cdc80df into main Apr 23, 2026
4 checks passed
@pfeerick pfeerick deleted the feat/changelog-generation branch April 23, 2026 05:02
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