Skip to content

release-runbook.md

Latest commit

 

History

History
90 lines (65 loc) · 1.97 KB

release-runbook.md

File metadata and controls

90 lines (65 loc) · 1.97 KB
Raw

Release Runbook

This runbook is the canonical release path for tailstick.

Scope

  • Cut a semver tag (vX.Y.Z)
  • Push tag to trigger GitHub Actions release workflow
  • Verify release artifacts and checks

Prerequisites

  • gh auth status returns a logged-in maintainer
  • local branch is up to date with origin/main
  • no uncommitted changes

Preflight Checklist

  1. Validate code quality:
go test ./...
go vet ./...
make icons
go build ./cmd/tailstick-linux-cli ./cmd/tailstick-linux-gui ./cmd/tailstick-windows-cli ./cmd/tailstick-windows-gui
make sandbox-linux
  1. Confirm version intent:
  • internal/app/cli.go Version constant matches release target.
  1. Confirm release workflow exists:
  • .github/workflows/release.yml triggers on v* tags.

Release Procedure

Assume target version is v1.0.0:

git checkout main
git pull --ff-only origin main
git tag v1.0.0
git push origin main
git push origin v1.0.0

Tag push triggers the release workflow which builds and uploads:

  • tailstick-cli-linux-amd64
  • tailstick-gui-linux-amd64
  • tailstick-cli-linux-arm64
  • tailstick-gui-linux-arm64
  • tailstick-cli-windows-amd64.exe
  • tailstick-gui-windows-amd64.exe
  • tailstick-cli-windows-arm64.exe
  • tailstick-gui-windows-arm64.exe

Verify Release

  1. Monitor workflow:
gh run list -R Microck/tailstick --workflow release.yml --limit 5
gh run watch -R Microck/tailstick <run-id> --exit-status
  1. Verify release entry and assets:
gh release view v1.0.0 -R Microck/tailstick
gh release view v1.0.0 -R Microck/tailstick --json assets,url
  1. Optional post-release smoke:
  • Download one Linux and one Windows binary and verify basic execution (tailstick version).

Rollback

If release workflow fails before artifacts are correct:

  1. Fix issue on main.
  2. Delete remote/local tag.
  3. Recreate and push corrected tag.
git tag -d v1.0.0
git push origin :refs/tags/v1.0.0
git tag v1.0.0
git push origin v1.0.0