Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
58 lines (44 loc) · 2.42 KB

RELEASE_CHECKLIST.md

File metadata and controls

58 lines (44 loc) · 2.42 KB

Release Checklist

Use this checklist when publishing a tagged Bomly CLI release.

Before tagging

  • Confirm main is green for required checks.
  • Run the smoke workflow or confirm the latest scheduled smoke result is healthy.
  • Confirm cmd/bomly/main.go contains the intended version after the Auto Version workflow.
  • Confirm release publishing credentials are configured in GitHub Actions.

Release workflow

  • Run Auto Version from main, choosing patch, minor, or major.
  • Wait for Release to finish.
  • Review the published GitHub release:
    • bomly archives exist for Linux, macOS, and Windows on amd64 and arm64.
    • bomly-lite archives exist for the same platforms.
    • SHA256SUMS exists.
    • .deb, .rpm, .apk, and Arch Linux package artifacts exist.
    • Homebrew, Scoop, and WinGet manifest PRs were opened or updated.
    • The landing-page sync PR updates /install.sh and /install.ps1 from this tag when those scripts changed.

Verification

Run the checks against the published release tag. Replace VERSION in the examples below with the actual release tag, such as v0.2.0.

gh release download VERSION --pattern SHA256SUMS --pattern 'bomly_VERSION_linux_amd64.tar.gz'
sha256sum --check SHA256SUMS --ignore-missing
tar -xzf bomly_VERSION_linux_amd64.tar.gz bomly
./bomly version

If practical, verify package-manager installs in clean runners or VMs. The bomly-dev/tap Homebrew reference is managed by GoReleaser through bomly-dev/homebrew-tap; no manual tap registration is required during release.

brew install --cask bomly-dev/tap/bomly
dpkg -i bomly_VERSION_linux_amd64.deb
rpm -i bomly_VERSION_linux_amd64.rpm
apk add --allow-untrusted bomly_VERSION_linux_amd64.apk

On Windows, validate:

winget install Bomly.BomlyCLI
scoop bucket add bomly https://github.com/bomly-dev/scoop-bucket
scoop install bomly

Publish and rollback

  • Merge package-manager PRs after their generated manifests pass review.
  • Confirm the landing-page docs sync PR opened.
  • If a release must be pulled, delete or unpublish the GitHub Release to trigger the automatic yanking workflow.
  • Close Homebrew and Scoop package-manager PRs that reference the bad tag, then tag a replacement patch release when appropriate.
  • For WinGet, confirm the release lifecycle workflow either skipped cleanup because no version manifest existed or opened a removal PR against microsoft/winget-pkgs.