* ci(bazel): add advisory Bazel workflow and setup-bazel action Add .github/workflows/bazel.yml, a side-by-side lane that runs `bazel test //... --config=ci` (PR Core parity) on pull_request, merge_group, push to main and workflow_dispatch. It is advisory: not in ci-gate's CI_GATE_REQUIRED. .github/actions/setup-bazel installs a sha256-pinned Bazelisk (Bazel from .bazelversion), restores the runner cache (--disk_cache and --repository_cache only), and writes a CI bazelrc outside the workspace and outside the cached directory. Remote execution is enabled only when BAZEL_REMOTE_EXECUTOR, RBE_TLS_CERT and RBE_TLS_KEY are all set (base64 PEM cert/key; optional RBE_TLS_CA, RBE_INSTANCE); none set (fork PRs, or workflow_dispatch rbe=off) runs locally; a partial set fails. The endpoint and its bare host are masked. The rc logic lives in write-bazelrc.sh so it is testable offline. The runner cache is saved only by push-to-main runs under a run-unique key and restored by prefix, so it never freezes at its first save and PRs do not churn the quota. The job also reports the tier (T1/T2/local) and wall time in the step summary, runs tools/bazel/critpath.py against the profile, and checks BUILD drift with make bazel-sync-check plus make bazel-sync and a clean git status. tools/bazel/critpath.py reports the critical path as the sum of the chained "critical path component" events rather than the longest one (a cold race build: 395s over 75 components, where the single-component version printed 69s and a false scheduling gap), lists the longest members and Bazel's processes: cache line, and checks a report-only budget (warning annotation, exit 0) unless --enforce is given. scripts/ci_workflow_test.go covers the new lane: not wired into any gate, every action SHA-pinned to the repo's released SHAs, no monolithic actions/cache, no unbounded apt-get, the cache topology, secrets only reaching setup-bazel, --profile after `test`, and the rc writer's none/partial/full/invalid-PEM/secret-dir-in-workspace behaviour. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * ci(bazel): check go test / Bazel test equivalence in the Bazel lane tools/bazel/equivalence.py compares the Go tests `bazel test //... --config=ci` ran with the ones pr.yml's go test lanes run, so a tag filter, a stray manual tag, a package without a go_test target, or a shard that runs zero tests cannot shrink the Bazel lane while it stays green: - package set: every package `go list -race -tags gms_pure_go` reports with test files has a go_test target (bazel query); - test-name set: every top-level TestXxx in the files go list selects (minus ^TestEmbedded, as PR Core skips) appears as a testcase in the test.xml of a go_test target this invocation tested (from the BEP); runtime skips count as run. Tests Bazel ran that go test would not are divergences too. Expected differences go in tools/bazel/equivalence_allowlist.txt, one justified line each (empty today); unused entries are reported. Results go to the step summary; the full listing with --details. .bazelrc test:ci now sets GO_TEST_WRAP_TESTV=1 (rules_go lists passing tests in test.xml only under -test.v) and downloads test.xml despite --remote_download_minimal. The Bazel workflow runs the check after the critical-path report, and nightly.yml calls the workflow (suite "bazel", and on schedule) with the full listing. Verified locally against a remote --config=ci run: 103 packages and 8843 tests on both sides. Tagging //internal/gitignore:gitignore_test manual keeps `bazel test` green but fails the check, listing its two tests. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * test(fs): run RepoContextAndRole from its own git repo The test relied on its working directory being inside a git checkout to make BEADS_DIR external to the CWD repo. Under Bazel the working directory is the runfiles tree, not a git repository, so RepoContext failed with "not a git repository" and the test skipped itself. Create a second temporary repo and chdir into it instead; go test keeps passing and Bazel now runs the assertions. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(bazel): fail equivalence on tests Bazel skips but go test passes The equivalence docstring claimed runtime skips count as run because go test skips them the same way. It does not: against PR Core's go test -json on the same commit, 11 tests passed under go test and skipped under Bazel while the check printed ok with an empty allowlist. - equivalence.py --go-test-json compares per-test status with the Bazel test.xml: passed under go test and skipped under Bazel is a divergence; other status differences are listed, not failed. The in-job (PR) run cannot see skip divergences and says so. - The allowlist gains a `skip` kind (`<pkg> <test> skip # why`, the justification still mandatory) and lists the 10 intentional skips: cmd/bd TestGOMODCACHENotUnderTestHome and TestZZStdioNotLeaked, and the scripts policy tests that walk the source checkout. The eleventh, fs TestContextRepository_RepoContextAndRole, is fixed in the test. - scripts/ci/pr-core.sh writes `go test -json` to BEADS_PR_CORE_GO_TEST_JSON when set (same flags otherwise). - nightly.yml runs that in a new job, uploads the JSON, and calls bazel.yml with go-test-json-artifact, which downloads it and passes --go-test-json to the equivalence step. Verified on a remote `bazel test //... --config=ci` run: ok with the allowlist; a TEST_SRCDIR-only t.Skip injected into internal/gitignore TestAppendLines fails the check (and passes the name-only in-job check, as documented). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * ci(bazel): freeze the runner cache per lock, mask key material, tighten policy Runner cache: every push to main saved ~2.3 GB (repository cache, disk cache, Bazelisk) under a run-unique key, on a repo already over its Actions cache quota. The cache now holds only the repository cache and Bazelisk, whose content is fixed by .bazelversion and MODULE.bazel.lock: exact key bazel-repo-v2-<os>-<hash>, restore falls back to the previous lock's entry, and only a push to main that missed the key saves. No --disk_cache in either mode (remote runs have the remote cache; local runs never used it). About 2 GB per lock change. Credentials: - write-bazelrc.sh masks every non-armor line of each decoded PEM (cert, key, CA). GitHub only masks the base64 value as stored. The CA used to be decoded inside the rc redirect, so its mask commands would have gone into the rc; it is decoded first now. - The CI rc sets build:remote-exec --noremote_upload_local_results, so CI never writes locally executed (PR-code) results into the shared action cache. Developer rcs keep Bazel's default. - RBE_INSTANCE stays optional; an empty one is a ::warning. - bazel.yml's header states the accepted risk: same-repo PR code runs with the RBE client certificate (as in gascity); forks never get it; what is in place and what is pending a human decision. Policy tests (each proved with a scratch mutation that now fails): triggers must be exactly pull_request, merge_group, push, workflow_dispatch and workflow_call (no pull_request_target); secrets may appear only in the setup-bazel step's env, not in workflow or job env, run, with or if; no continue-on-error anywhere in bazel.yml or setup-bazel; the cache-save if is matched exactly; the critical-path and equivalence steps must end with the bare script call and the test step with exit "$rc", with no exit 0, || true, || :, ; true, set +e or trap. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(ci): record the same-repo RBE decision in bazel.yml Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(ci): bazel wrapper version check; keep go-test prose out of the build-tag scan The wrapper prepends --bazelrc, so 'bazel --version' reached the server as an unknown startup option; ask bazelisk directly. check-build-tags matched 'go test' in workflow prose and step names. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(ci): run the RBE lane on Blacksmith runners; mask the executor's IPs GitHub-hosted runners are refused by the remote-execution edge; the Blacksmith pool (as in gascity) is admitted and does not count against GitHub's concurrent-job cap. Forks and rbe=off keep ubuntu-latest. Bazel prints the resolved executor address in connection errors, so mask every address the endpoint host resolves to. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * ci(bazel): target rbe-west (instance oss) behind RBE_WEST_WORKERS The original edge does not admit CI runners. Mirror gascity: remote execution uses secrets.RBE_WEST_EXECUTOR and instance oss when the repo variable RBE_WEST_WORKERS is true; same-repo runs are skipped until then instead of failing, while forks and rbe=off still run locally. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| bench-ready-indexes | ||
| ci | ||
| gitattributespolicy | ||
| hooks | ||
| migration-test | ||
| prlintmake | ||
| repro-be-1he-slow-path | ||
| repro-dolt-hang | ||
| repro-dolt-prod-timeouts | ||
| bazel_policy_test.go | ||
| build-examples.sh | ||
| BUILD.bazel | ||
| bump-version.sh | ||
| check-build-tags.sh | ||
| check-cli-docs-drift.sh | ||
| check-doc-flags.sh | ||
| check-doc-freshness.sh | ||
| check-go-install-guidance.sh | ||
| check-migration-hygiene.sh | ||
| check-testing-short.sh | ||
| check-versions.sh | ||
| check_build_tags_test.go | ||
| check_doc_freshness_test.go | ||
| check_testing_short_test.go | ||
| ci_capability_selector_test.go | ||
| ci_workflow_apt_get_timeout_test.go | ||
| ci_workflow_test.go | ||
| clean-test-tmp.sh | ||
| complexity_script_test.go | ||
| conformance.sh | ||
| conformance_script_test.go | ||
| cross-version-smoke-test.sh | ||
| docs-autofix-push.sh | ||
| docs.md | ||
| gen-winres.sh | ||
| generate-cli-docs.sh | ||
| generate-newsletter.py | ||
| generate-newsletter_README.md | ||
| gh-body-lint | ||
| host_tools_test.go | ||
| install-hooks.sh | ||
| install.sh | ||
| install_dolt_test.go | ||
| migrate-jsonl-to-dolt.sh | ||
| migrate-legacy-to-current.sh | ||
| mutation-equivalence.sh | ||
| pr-preflight.sh | ||
| pr_preflight_test.go | ||
| pull_dolt_image_test.go | ||
| README.md | ||
| release.sh | ||
| release_script_test.go | ||
| resolve-docs-bd.sh | ||
| sign-windows.sh | ||
| test-cgo.sh | ||
| test-git-remote.sh | ||
| test-icu-path.sh | ||
| test.sh | ||
| test_script_test.go | ||
| update-nix-vendorhash.sh | ||
| update-versions.sh | ||
| update-winget.sh | ||
| upgrade-smoke-test.sh | ||
| verify-cgo.sh | ||
Beads Scripts
Utility scripts for maintaining the beads project.
ci/
Repository-owned CI command wrappers. These scripts are the source of truth for the target CI tiers; Make targets are aliases for local discoverability.
make ci-pr-core
make ci-pr-policy
make ci-pr-lint
make ci-package-mcp
make ci-package-npm
Each wrapper auto-detects the repository root, sources .buildflags when it
invokes Go in the default build mode, and records per-command timing through
scripts/ci/lib/timing.sh.
Broad Go test wrappers also source scripts/ci/lib/test-env.sh, which creates a
temporary HOME/XDG/Dolt root, isolates Git global/system config, clears runtime
Beads/Dolt environment variables, and sets BEADS_TEST_SKIP=dolt before tests
run. This keeps local make test and make ci-pr-core results comparable to
the fast PR-core contract even on shared agent hosts. Set
BEADS_TEST_ENV_RUN_DOLT=1 only when intentionally running the Dolt-dependent
tests through these broad wrappers, or BEADS_TEST_ENV_DISABLE=1 when debugging
against your real local configuration.
The broad Go wrappers also cap package and test parallelism to 4 by default
(GO_TEST_PKG_PARALLEL and GO_TEST_PARALLEL). This avoids turning high-core
shared hosts into a different test topology than GitHub Actions.
make ci-pr-policy includes scripts/check-testing-short.sh, which enforces
that testing.Short() is only used for runtime, stress, or large-fixture skips.
Use build tags, environment checks, or named wrappers for integration/e2e/API
boundaries.
Package gate wrappers validate publishable/package-adjacent surfaces:
make ci-package-mcpbuilds or consumes abdbinary, puts it onPATHasbd, then runs locked MCP packageuv sync, Ruff, mypy, pytest, and build checks.make ci-package-npmbuilds or consumes the native binary expected bynpm-package/bin/bd, runs the npm package test suite, and checksnpm pack --dry-run.
Set BEADS_TEST_BD_BINARY=/path/to/bd for MCP and npm package gates to reuse a
prebuilt candidate binary instead of rebuilding it inside the wrapper.
pr-preflight.sh
Read-only PR safety check for agents and maintainers.
# Before implementing or opening a related PR
./scripts/pr-preflight.sh --search "topic keywords" --repo gastownhall/beads
# Before changing, closing, or merging an existing PR
./scripts/pr-preflight.sh 123 --repo gastownhall/beads
It reports contributor/fork status, draft/review/merge/check state, risky diff
signals such as .beads/ changes or missing tests, and the required
contributor-protection next steps. It does not replace code review or local
validation.
Base-branch health is supplemented by a warn-only PR-gate sample: the last 60
completed pull_request-event runs, grouped per workflow. A single workflow
whose decisive runs (>= 5, across >= 3 distinct head branches) are all
failure-class is reported as a broken PR gate — the case where a job that
exists only in the PR workflow is red for every PR while the base branch shows
green. This detector never blocks (deliberately: automation classifies
unrecognized [block] lines as genuine merge blockers and would park merge
lanes on a false positive); it is skipped entirely while the base branch is
red.
gh-body-lint
Lint Markdown files before posting them with gh ... --body-file.
./scripts/gh-body-lint body.md
./scripts/gh-body-lint --fix body.md
The lint catches literal \n sequences, which render poorly on GitHub, and
GH#123 references, which do not auto-link like #123 or owner/repo#123.
release.sh (⭐ The Easy Button)
One-command release from version bump to local installation.
Usage
# Full release (does everything)
./scripts/release.sh 0.9.3
# Preview what would happen
./scripts/release.sh 0.9.3 --dry-run
What It Does
This master script automates the entire release process:
- ✅ Stops running Dolt servers (avoids version conflicts)
- ✅ Runs tests and linting
- ✅ Bumps version in all files
- ✅ Commits and pushes version bump
- ✅ Creates and pushes git tag
- ✅ Verifies or opens the Homebrew core formula PR
- ✅ Upgrades local Homebrew installation
- ✅ Verifies everything works
After this script completes, your system is running the new version!
Examples
# Release version 0.9.3
./scripts/release.sh 0.9.3
# Preview a release (no changes made)
./scripts/release.sh 1.0.0 --dry-run
Prerequisites
- Clean git working directory
- All changes committed
- golangci-lint installed
- Homebrew installed (for local upgrade)
- Push access to gastownhall/beads
Output
The script provides colorful, step-by-step progress output:
- 🟨 Yellow: Current step
- 🟩 Green: Step completed
- 🟥 Red: Errors
- 🟦 Blue: Section headers
What Happens Next
After the script finishes:
- GitHub Actions builds binaries for all platforms (~5 minutes)
- PyPI package is published automatically
- Homebrew core formula is verified or tracked through its canonical PR
- Users can
brew upgrade beadsto get the new version after Homebrew merges - GitHub Release is created with binaries and changelog
bump-version.sh
Bumps the version number across all beads components in a single command.
Usage
# Show usage
./scripts/bump-version.sh
# Update versions (shows diff, no commit)
./scripts/bump-version.sh 0.9.3
# Update versions and auto-commit
./scripts/bump-version.sh 0.9.3 --commit
What It Does
Updates version in all these files:
cmd/bd/version.go- bd CLI version constantplugins/beads/.claude-plugin/plugin.json- Claude plugin versionplugins/beads/.codex-plugin/plugin.json- Codex plugin version.claude-plugin/marketplace.json- Claude marketplace plugin versionintegrations/beads-mcp/pyproject.toml- MCP server versionREADME.md- Alpha status versionPLUGIN.md- Version requirements
Features
- Validates semantic versioning format (MAJOR.MINOR.PATCH)
- Verifies all versions match after update
- Shows git diff of changes
- Auto-commits with standardized message (optional)
- Cross-platform compatible (macOS and Linux)
Examples
# Bump to 0.9.3 and review changes
./scripts/bump-version.sh 0.9.3
# Review the diff, then manually commit
# Bump to 1.0.0 and auto-commit
./scripts/bump-version.sh 1.0.0 --commit
git push origin main
Why This Script Exists
Previously, version bumps only updated cmd/bd/version.go, leaving other components out of sync. This script ensures all version numbers stay consistent across the project.
Safety
- Checks for uncommitted changes before proceeding
- Refuses to auto-commit if there are existing uncommitted changes
- Validates version format before making any changes
- Verifies all versions match after update
- Shows diff for review before commit
sign-windows.sh
Signs Windows executables with an Authenticode certificate using osslsigncode.
Usage
# Sign a Windows executable
./scripts/sign-windows.sh path/to/bd.exe
# Environment variables required for signing:
export WINDOWS_SIGNING_CERT_PFX_BASE64="<base64-encoded-pfx>"
export WINDOWS_SIGNING_CERT_PASSWORD="<certificate-password>"
What It Does
This script is called automatically by GoReleaser during the release process:
- Decodes the PFX certificate from base64
- Signs the Windows executable using osslsigncode
- Timestamps the signature using DigiCert's RFC3161 server
- Replaces the original binary with the signed version
- Verifies the signature was applied correctly
Prerequisites
osslsigncodeinstalled (apt install osslsigncodeorbrew install osslsigncode)- EV code signing certificate exported as PFX file
- GitHub secrets configured:
WINDOWS_SIGNING_CERT_PFX_BASE64- base64-encoded PFX fileWINDOWS_SIGNING_CERT_PASSWORD- certificate password
Graceful Degradation
If the signing secrets are not configured:
- The script prints a warning and exits successfully
- GoReleaser continues without signing
- The release proceeds with unsigned Windows binaries
This allows releases to work before a certificate is acquired.
Why This Script Exists
Windows code signing helps reduce antivirus false positives that affect Go binaries.
Kaspersky and other AV software commonly flag unsigned Go executables as potentially
malicious due to heuristic detection. See docs/reference/antivirus.md for details.
Future Scripts
Additional maintenance scripts may be added here as needed.