beads/.github/workflows/release.yml
Julian Knutsen 2d395d35af
ci(release): never restore Actions caches into release builds (#6966)
setup-go's default cache in release.yml is keyed predictably and falls back
to the default branch's Go module and build caches, which are restored
without re-verification before binaries are built, signed and attested.
Turn it off in every release job and pin that with a policy test.

Co-authored-by: Gas City Adopt-PR <adopt-pr@gascity.local>
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-30 04:39:23 -07:00

452 lines
18 KiB
YAML

name: Release
on:
push:
tags:
- 'v*'
# Manual dispatch is only for rerunning a release from a v* tag. Publishing
# jobs below are tag-gated and skip branch refs.
workflow_dispatch:
concurrency:
group: release-${{ github.ref }}
cancel-in-progress: false
permissions:
contents: write
id-token: write
attestations: write
env:
BD_DISABLE_METRICS: "1"
BD_DISABLE_EVENT_FLUSH: "1"
jobs:
# Pre-publish gate: refuse to publish a release whose version constants and
# Docusaurus docs snapshot disagree. This blocks the failure mode where a tag
# ships with version.go bumped but the docs snapshot missing (which otherwise
# only surfaces as a red main after the artifacts are already published).
verify-version-consistency:
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
with:
fetch-depth: 0
- name: Verify tag matches version.go
run: |
tag_version="${GITHUB_REF_NAME#v}"
code_version="$(grep 'Version = ' cmd/bd/version.go | sed 's/.*"\(.*\)".*/\1/')"
if [ "$tag_version" != "$code_version" ]; then
echo "ERROR: tag v$tag_version does not match cmd/bd/version.go ($code_version)" >&2
exit 1
fi
echo "OK: tag and version.go agree on $code_version"
- name: Check version consistency
run: ./scripts/check-versions.sh
release-package-mcp:
name: Release Package Gate (MCP)
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') }}
needs: verify-version-consistency
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version-file: 'go.mod'
# Never restore a cache into release builds: setup-go's key is
# predictable and falls back to main's cache, whose module and build
# caches are not re-verified before binaries are built and signed.
cache: false
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: '3.14'
- name: Install uv
run: python -m pip install uv==0.11.16
- name: Run MCP package gate
run: make ci-package-mcp
- name: Upload validated MCP dist
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
with:
name: release-mcp-dist
path: integrations/beads-mcp/dist/*
if-no-files-found: error
retention-days: 7
release-package-npm:
name: Release Package Gate (npm)
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') }}
needs: verify-version-consistency
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version-file: 'go.mod'
# Never restore a cache into release builds: setup-go's key is
# predictable and falls back to main's cache, whose module and build
# caches are not re-verified before binaries are built and signed.
cache: false
- name: Set up Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6
with:
node-version: '24'
- name: Run npm package gate
run: make ci-package-npm
goreleaser:
# Guard: only run goreleaser in the canonical repository (not in forks)
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') }}
needs:
- release-package-mcp
- release-package-npm
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
with:
fetch-depth: 0
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version-file: 'go.mod'
# Never restore a cache into release builds: setup-go's key is
# predictable and falls back to main's cache, whose module and build
# caches are not re-verified before binaries are built and signed.
cache: false
- name: Install cross-compilation toolchains and signing tools
# Backstop for a hang that escapes the inner `timeout` calls, so it has
# to sit ABOVE what those calls can legitimately consume: 3 update
# attempts x 120s + 2 backoffs x 10s + 300s install = 680s worst case.
# 13m leaves ~100s of headroom. This job sets no job-level
# timeout-minutes, so this cap is the only bound on a stuck apt.
timeout-minutes: 13
run: |
updated=""
for attempt in 1 2 3; do
if sudo timeout 120 apt-get \
-o Acquire::Retries=3 \
-o Acquire::http::Timeout=30 \
-o Acquire::https::Timeout=30 \
update; then
updated=yes
break
fi
echo "::warning::apt-get update attempt $attempt failed or timed out"
# No backoff after the final attempt - there is nothing left to wait for.
if [ "$attempt" -lt 3 ]; then
sleep 10
fi
done
# Deliberate best-effort: a stale index still installs these packages
# from the runner image cache far more often than not, and failing the
# job here would turn a transient mirror outage into a red build. The
# warning is what makes the degraded path visible in the job log.
if [ -z "$updated" ]; then
echo "::warning::apt-get update failed after 3 attempts; proceeding with cached index"
fi
sudo timeout 300 apt-get install -y gcc-mingw-w64-x86-64 gcc-aarch64-linux-gnu osslsigncode
- name: Install go-winres for Windows PE resource embedding
run: go install github.com/tc-hib/go-winres@latest
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@f06c13b6b1a9625abc9e6e439d9c05a8f2190e94 # v7
with:
distribution: goreleaser
version: '~> v2'
args: >
release --clean --parallelism 1
${{ github.repository != 'gastownhall/beads' && '--skip=publish --skip=announce' || '' }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Windows code signing (optional - signing is skipped if not set)
WINDOWS_SIGNING_CERT_PFX_BASE64: ${{ secrets.WINDOWS_SIGNING_CERT_PFX_BASE64 }}
WINDOWS_SIGNING_CERT_PASSWORD: ${{ secrets.WINDOWS_SIGNING_CERT_PASSWORD }}
- name: Verify no ICU runtime dependency on Linux binaries
run: |
for bin in dist/bd-linux-*/bd; do
[ -f "$bin" ] || continue
if ldd "$bin" 2>/dev/null | grep -qi icu; then
echo "ERROR: $bin has unexpected ICU runtime dependency" >&2
ldd "$bin" >&2
exit 1
fi
echo "OK: $bin has no ICU runtime dependency"
done
- name: Publish the contract corpus as a release artifact
# Ships the canonicalized golden corpus (cmd/bd/protocol/testdata/corpus)
# with each release and appends its checksum to the release checksums.txt,
# so a downstream consumer can anchor its vendored-corpus drift-check to a signed
# beads release rather than a self-recomputed manifest. Runs before the
# macOS job's serial checksums.txt append (goreleaser-macos needs this
# job), so the entry is preserved.
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
set -euo pipefail
tag="${GITHUB_REF_NAME}"
version="${tag#v}"
archive="beads_${version}_contract_corpus.tar.gz"
tar -czf "$archive" -C cmd/bd/protocol/testdata corpus
shasum -a 256 "$archive" | tee corpus-checksum.txt
gh release upload "$tag" "$archive" --clobber
gh release download "$tag" --pattern checksums.txt --dir /tmp/corpus-sums
sums=/tmp/corpus-sums/checksums.txt
# Idempotent on a job re-run (manual retry or flake): drop any prior
# entry for this archive before appending the fresh checksum, so the
# re-download+append never leaves a duplicate (or stale) corpus row.
if [ -f "$sums" ]; then
grep -vF "$archive" "$sums" > "$sums.tmp" || true
mv "$sums.tmp" "$sums"
fi
cat corpus-checksum.txt >> "$sums"
gh release upload "$tag" "$sums" --clobber
goreleaser-macos:
# Build macOS binaries with CGO_ENABLED=1 for embedded Dolt support.
# Runs on native macOS to avoid zig/osxcross cross-compilation issues.
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') }}
needs: goreleaser
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
with:
fetch-depth: 0
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version-file: 'go.mod'
# Never restore a cache into release builds: setup-go's key is
# predictable and falls back to main's cache, whose module and build
# caches are not re-verified before binaries are built and signed.
cache: false
- name: Extract version from tag
id: version
run: echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
- name: Build darwin/arm64
env:
CGO_ENABLED: "1"
GOARCH: arm64
GOOS: darwin
run: |
go build -tags "gms_pure_go netgo" \
-ldflags "-s -w -X main.Version=${{ steps.version.outputs.version }} -X main.Build=$(git rev-parse --short HEAD) -X main.Commit=$(git rev-parse HEAD) -X main.Branch=$(git branch --show-current)" \
-o bd-darwin-arm64 ./cmd/bd
./scripts/verify-cgo.sh bd-darwin-arm64
# Verify no ICU runtime dependency leaked through
if otool -L bd-darwin-arm64 | grep -qi icu; then
echo "ERROR: bd-darwin-arm64 has unexpected ICU runtime dependency" >&2
otool -L bd-darwin-arm64 >&2
exit 1
fi
codesign -s - -f bd-darwin-arm64
- name: Build darwin/amd64
env:
CGO_ENABLED: "1"
GOARCH: amd64
GOOS: darwin
# macos-latest is arm64; cross-compile CGO C code for x86_64
CC: clang -arch x86_64
CXX: clang++ -arch x86_64
run: |
go build -tags "gms_pure_go netgo" \
-ldflags "-s -w -X main.Version=${{ steps.version.outputs.version }} -X main.Build=$(git rev-parse --short HEAD) -X main.Commit=$(git rev-parse HEAD) -X main.Branch=$(git branch --show-current)" \
-o bd-darwin-amd64 ./cmd/bd
./scripts/verify-cgo.sh bd-darwin-amd64
if otool -L bd-darwin-amd64 | grep -qi icu; then
echo "ERROR: bd-darwin-amd64 has unexpected ICU runtime dependency" >&2
otool -L bd-darwin-amd64 >&2
exit 1
fi
codesign -s - -f bd-darwin-amd64
- name: Smoke test embedded dolt (arm64 native)
run: |
# arm64 binary runs natively on macos-latest
bd="$(pwd)/bd-darwin-arm64"
tmpdir=$(mktemp -d)
projdir="$tmpdir/smoketest"
mkdir -p "$projdir"
cd "$projdir"
git init -b main
git config user.name "CI" && git config user.email "ci@test"
git commit --allow-empty -m "init"
"$bd" init --prefix smoketest
"$bd" create "smoke test" --type task
"$bd" list | grep -q "smoke test"
# Verify embedded mode (no server process)
if pgrep -f "dolt sql-server" >/dev/null 2>&1; then
echo "ERROR: unexpected dolt sql-server process running" >&2
exit 1
fi
echo "OK: embedded dolt smoke test passed"
cd - >/dev/null
rm -rf "$tmpdir"
- name: Package archives
run: |
version="${{ steps.version.outputs.version }}"
for arch in arm64 amd64; do
staging="beads_${version}_darwin_${arch}"
mkdir -p "$staging"
cp "bd-darwin-${arch}" "$staging/bd"
cp LICENSE README.md CHANGELOG.md "$staging/"
tar -czf "${staging}.tar.gz" -C "$staging" .
shasum -a 256 "${staging}.tar.gz" >> darwin-checksums.txt
done
- name: Upload to GitHub release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
version="${{ steps.version.outputs.version }}"
for arch in arm64 amd64; do
gh release upload "v${version}" "beads_${version}_darwin_${arch}.tar.gz" --clobber
done
- name: Append checksums to release checksums.txt
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
version="${{ steps.version.outputs.version }}"
# Download existing checksums, append darwin entries, re-upload
gh release download "v${version}" --pattern checksums.txt --dir /tmp/checksums
cat darwin-checksums.txt >> /tmp/checksums/checksums.txt
gh release upload "v${version}" /tmp/checksums/checksums.txt --clobber
attest-release:
# Attest the complete release after GoReleaser assets and the native macOS
# archives have both populated checksums.txt.
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') }}
needs: [goreleaser, goreleaser-macos]
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
- name: Resolve release asset paths
id: assets
run: |
mkdir -p dist
echo "checksums=dist/checksums.txt" >> "$GITHUB_OUTPUT"
echo "sbom=dist/beads-${GITHUB_REF_NAME}.spdx.json" >> "$GITHUB_OUTPUT"
- name: Download release checksums
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh release download "${GITHUB_REF_NAME}" --pattern checksums.txt --dir dist
- name: Generate release SBOM
uses: anchore/sbom-action@e22c389904149dbc22b58101806040fa8d37a610 # v0
with:
path: .
format: spdx-json
output-file: ${{ steps.assets.outputs.sbom }}
upload-artifact: false
upload-release-assets: false
- name: Upload release SBOM
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh release upload "${GITHUB_REF_NAME}" "${{ steps.assets.outputs.sbom }}" --clobber
- name: Attest release artifacts
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4
with:
subject-checksums: ${{ steps.assets.outputs.checksums }}
- name: Attest release SBOM
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4
with:
subject-checksums: ${{ steps.assets.outputs.checksums }}
sbom-path: ${{ steps.assets.outputs.sbom }}
publish-pypi:
runs-on: ubuntu-latest
needs: [release-package-mcp, goreleaser]
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') && !contains(github.ref_name, '-') }}
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: '3.14'
- name: Install uv
run: python -m pip install uv==0.11.16
- name: Download validated MCP dist
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
with:
name: release-mcp-dist
path: integrations/beads-mcp/dist
- name: Verify validated MCP dist
run: |
test -n "$(find integrations/beads-mcp/dist -maxdepth 1 -type f -print -quit)"
ls -la integrations/beads-mcp/dist
- name: Publish to PyPI
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: |
cd integrations/beads-mcp
uv tool run twine upload dist/*
publish-npm:
runs-on: ubuntu-latest
needs: [release-package-npm, goreleaser, goreleaser-macos]
if: ${{ github.repository == 'gastownhall/beads' && startsWith(github.ref, 'refs/tags/v') && !contains(github.ref_name, '-') }}
permissions:
contents: read
id-token: write # Required for npm provenance/trusted publishing
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
- name: Set up Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6
with:
node-version: '24'
registry-url: 'https://registry.npmjs.org'
- name: Update npm for OIDC trusted publishing
run: npm install -g npm@latest # Requires npm >= 11.5.1 for trusted publishing
- name: Publish to npm
run: |
cd npm-package
npm publish --access public
# Uses OIDC trusted publishing - no token needed
# Provenance attestations are automatic with trusted publishing