Skip to content

RELEASING.md

Latest commit

 

History

History
100 lines (74 loc) · 3.4 KB

RELEASING.md

File metadata and controls

100 lines (74 loc) · 3.4 KB
Raw

Release Process

This document describes the steps to cut a new release of go-coverage-report.

Versioning

This project follows Semantic Versioning:

  • Patch (v1.x.Y): bug fixes only
  • Minor (v1.Y.0): new features, backwards-compatible
  • Major (vX.0.0): breaking changes

Steps

1. Update CHANGELOG.md

  • Rename the ## [Unreleased] section to ## [vX.Y.Z] - YYYY-MM-DD
  • Add a new ## [Unreleased] section at the top with the content _Nothing yet_
  • Update the comparison links at the bottom of the file: 
    [Unreleased]: https://github.com/fgrosse/go-coverage-report/compare/vX.Y.Z...HEAD
[vX.Y.Z]: https://github.com/fgrosse/go-coverage-report/compare/vA.B.C...vX.Y.Z

2. Update version references

Bump the version to vX.Y.Z in:

  • action.yml — the version input default value
  • README.md — the version input default value in the inputs reference, and the uses: example in the usage section

3. Commit and push to main

git add CHANGELOG.md action.yml README.md
git commit -m "Release vX.Y.Z"
git push origin main

4. Create and push a signed tag

git tag -s vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z

Important: The tag must point to the commit that includes all the version bumps above. If you need to move the tag (e.g. you pushed it too early), run:

git tag -f -s vX.Y.Z -m "Release vX.Y.Z"
git push --force origin vX.Y.Z

Only do this before running goreleaser, as force-pushing a tag after a GitHub Release is published will cause issues.

5. Run goreleaser

Extract the release notes for the current version from CHANGELOG.md and pass them to goreleaser:

VERSION=vX.Y.Z
awk "/^## \[$VERSION\]/{found=1; next} /^## \[v/{if(found) exit} found" CHANGELOG.md > /tmp/release-notes.md
goreleaser release --clean --release-notes=/tmp/release-notes.md

This will:

  • Build binaries for Linux, macOS, and Windows
  • Create tarballs and a checksums.txt
  • Publish a GitHub Release with the built artifacts

Important: --release-notes does not currently reach the published release. Our .goreleaser.yaml sets changelog.disable: true, which skips the pipeline stage that applies the flag, so goreleaser publishes the release with an empty body. This is silent, there is no warning.

6. Set the release notes

Because of the above, attach the notes explicitly after goreleaser has published:

gh release edit "$VERSION" --notes-file=/tmp/release-notes.md

7. Verify the release

gh release view "$VERSION" --json tagName,isDraft,body --jq '.tagName, .isDraft, .body'
gh release view "$VERSION" --json assets --jq '.assets[].name'

Check that the body is not empty, that the release is not a draft, and that all nine assets are present (eight archives plus checksums.txt).

Checklist

  • CHANGELOG.md updated (unreleased → version + date, new empty unreleased section, links)
  • action.yml default version bumped
  • README.md version references bumped
  • Changes committed and pushed to main
  • Signed tag created and pushed (pointing to the version-bump commit)
  • goreleaser release --clean --release-notes=/tmp/release-notes.md run successfully
  • Release notes attached with gh release edit (goreleaser leaves the body empty)
  • Release verified: non-empty body, not a draft, all nine assets uploaded