Skip to content

chore(release): set up versioned releases and generated changelog - #2897

Draft
susilnem wants to merge 5 commits into
developfrom
chore/release-process
Draft

susilnem wants to merge 5 commits into
developfrom
chore/release-process

Conversation

@susilnem

@susilnem susilnem commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Summary

Switch go-api to tag-based releases.

  • Staging runs develop builds day to day, and each release tag is deployed there first for testing
  • Production runs only released vX.Y.Z versions — the same chart tested on staging
  • Hotfixes branch from the production tag, so unreleased develop work stays out

Changes

  • CI: remove the master and temporary feature/banjo-stack publish triggers
  • Changelog: move the hand-written CHANGELOG.md to CHANGELOG-legacy.md
  • release.sh:
    • START_COMMIT set to the last commit covered by the legacy changelog (86b9ddd3), so the generated changelog continues where it stops
    • git-cliff footer links to CHANGELOG-legacy.md
  • fugit: bump to v0.3.1 to fix release.sh exiting with 141 (SIGPIPE) on repos with many tags (fix(release): avoid SIGPIPE when listing tags under pipefail toggle-corp/fugit#4)
  • Docs: add docs/release.md (release, hotfix, rollback); README links to it

What a vX.Y.Z tag publishes

Artifact Name
Docker image ghcr.io/ifrcgo/go-api:vX.Y.Z.c<sha7>
Helm chart oci://ghcr.io/ifrcgo/ifrcgo-helm:X.Y.Z-<sha7>
GitHub Release vX.Y.Z, with the generated changelog and the chart version to deploy

Heads-up for contributors

The changelog is generated from commit messages. Every commit needs a Conventional Commit prefix (feat:, fix:, chore: …), otherwise it's left out of the changelog. Merge commits are ignored.

Before the first release

  • fugit fix merged and submodule bumped (v0.3.1)
  • Decide the first version (an old v7.0.0 tag exists -> v7.1.0 or v8.0.0)
  • go-deploy: point staging, then production, targetRevision to the first release.

Follow-up

Testing

  • Ran release.sh in a throwaway clone (nothing pushed): the changelog contains only commg, and the footer link is correct.
  • Checked that commits without a prefix (e.g. Fix broken /docs) and merge commits don't appear in the generated changelog.

@szabozoltan69

Copy link
Copy Markdown
Contributor

We can change to v8.0.0, as a new main version.

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.

2 participants