* test: ban ungated host go/gofmt execs under Bazel; pin compact_gc_fixture pure/norace Follow-up to #7478. Adds two policy tests on //scripts:go_sources_test: - host_tool_exec_policy_test.go: an AST scan of every *_test.go file and internal/testutil's non-test .go files for exec.Command/CommandContext/ LookPath("go"/"gofmt") that isn't gated by bazeltest.IsBazel()/TEST_SRCDIR in its enclosing function, with an explicit, justified allowlist for the handful of sites gated by caller dataflow instead (bazeltest.PrebuiltBD() checked before calling a separate helper). "dolt" is out of scope: the hermetic copy resolves first on Bazel's PATH, unlike go/gofmt. - host_tool_shell_policy_test.go: the same policy for the shell scripts under scripts/ that Bazel sh_test/go_test targets actually execute (fmt-check.sh, the repochecks guards, gofmt-bin.sh, the migration-test harness), matching the gating pattern #7478 added to fmt-check.sh and scripts/ci/lib/test-env.sh. Both are mutation-verified (an added ungated exec.Command("go","version")/ `go build` is detected, then reverted cleanly). Also sets pure = "on" and race = "off" on cmd/bd/BUILD.bazel's compact_gc_fixture go_binary, matching :bd_for_tests/:cmd_norace: it is a testonly, stdlib-only fixture, so neither cgo nor the race detector buys it anything, under any --config. Verified TestRunCompactDoltTargetsOnlyAuthorizedActiveDatabase still passes via `bazel --nohome_rc test` under both --config=prcore and --config=doltserver-cmd. Known pre-existing issue, out of scope here: gosec's GoVersion() call still execs a host `go` from third-party code this policy doesn't reach. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(scripts): address review of host-tool exec/shell policy (#7485) Fixes all 6 maintainer-city-c3 review items against the ban-ungated-go/ gofmt-exec policy, each with a mutation test proving the fix catches the described regression: 1. Shell scan now gates per-branch/per-call-site (shellLineGating), not by any TEST_SRCDIR mention anywhere in the whole file. 2. Shell scanner adds gofmt and `go tool` detection, fixes the heredoc-start regex (no longer swallows the rest of the script on an arithmetic `<<` shift or a `<<<` here-string), and replaces the blanket printf/echo/git-grep line skip with a quoted-span/command- substitution-aware check that still catches a real exec joined onto a message line with `&&`. 3. shellPolicyScope gains pr-lint.sh, check-versions.sh, upgrade-smoke-test.sh and the 4 .github/scripts shard fallbacks, each cited against its real BUILD.bazel/.bzl wiring; corrects two factually wrong "not executed" doc-comment claims (pr-lint.sh and upgrade-smoke-test.sh ARE Bazel-executed); and adds TestShellPolicyScopeCoversBazelShellData, a mechanical backstop that fails on a Bazel-referenced .sh under scripts/ or .github/scripts/ missing from scope. 4. hostToolExecAllowlist no longer exempts goBuildBDCommand's 9 call sites by helper name; helperIsGatedByAllCallers checks every real call site is itself gated. 5. Both allowlists are keyed by file + enclosing function + exact snippet, not line number. 6. gated()/shellLineGating understand condition polarity, so an inverted `if !IsBazel() { t.Skip() }` (or its shell equivalent) is correctly NOT counted as a gate. Also extends the Go scanner's condPolarity to recognize findPrebuiltBDBinary()/bazeltest.PrebuiltBD() result variables as a TEST_SRCDIR-equivalent gate (proven safe by reading their implementation), and the shell scanner's analogous shellBazelSetVars for CANDIDATE_BIN/SOURCE_TAG_SQLITE_BIN/BEADS_TEST_*_BINARY, including through a script's own default-value variable alias (`VAR="${BAZEL_VAR:-default}"`). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(scripts): give go_sources_test runfiles access to the new shell scope The shell-policy rewrite (host_tool_shell_policy_test.go) added shellPolicyScope entries for scripts/ci/pr-lint.sh, scripts/check-versions.sh, scripts/upgrade-smoke-test.sh, and the four .github/scripts/*-test-shard.sh files, plus a scope-coverage guard (TestShellPolicyScopeCoversBazelShellData) that walks every tracked BUILD.bazel file. None of those were runfiles of //scripts:go_sources_test, so bazel test passed locally under plain `go test` but failed in CI's hermetic Bazel sandbox with "no such file or directory" for the new scope entries and "found only 0 BUILD.bazel files" for the guard's walk. Add //:repo_other_files (every tracked non-Go, non-Markdown file, including every BUILD/.bzl file) to go_sources_test's data, mirroring the same pattern already used by //scripts:scripts_test. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(scripts): rename AST-fixture function so it isn't counted as a real test tools/bazel/equivalence.py compares `go test`'s discovered top-level tests against what Bazel actually ran, using a raw-text regex (`^func\s+(Test\w*)\s*\(\s*\w+\s+\*testing\.T\s*\)`) rather than compiling the file. The "inverted IsBazel skip" fixture in host_tool_exec_policy_test.go embeds a column-0 `func TestSomething(t *testing.T) {` inside a backtick string used to build an AST for findHostToolExecCalls, which the regex scan counted as a real top-level test that Bazel's go_sources_test then "failed to run" (CI's Bazel / test leg: EQUIVALENCE: FAIL on "scripts TestSomething"). Rename the fixture's inner function to bazelOnlyFixture; the test's behavior is unchanged since the name was never semantically significant to the scan being exercised. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(scripts): close host-go-policy gaps from PR #7485 re-review Four fixes from the final review round: 1. test.sh/conformance.sh/release.sh ARE in scope (they run under Bazel via scripts/** data globs); drop the false "not in scope" claims and add justified fn-keyed allowlist entries for their 8 flagged execs. 2. Go AST: an exec inside the Bazel-true branch, before its own abort, is no longer wrongly counted as gated (M17); a gate inside a sibling closure no longer covers execs outside it. 3. Shell scanner: abort/skip gate state now resets at function-scope end (a top-level `go build` after build_candidate in upgrade-smoke-test.sh is correctly flagged), and `bash -c 'go build'` is detected again. 4. Split host_tool_shell_policy_test.go into its own go_test (shell_host_tool_policy_test) with narrow, curated data instead of riding go_sources_test's //:repo_other_files; restored go_sources_test's data to its pre-PR scope. Dropped TestShellPolicyScopeCoversBazelShellData: its regex backstop could not see Starlark labels/.bzl/globs and still missed real in-scope scripts, so it wasn't earning its cache-rerun cost. The new target carries no tags, so it still runs in the required "Bazel / test" lane. Each of 1-3 ships with a mutation-proof fixture that fails on the prior code and passes on the fix. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(scripts): rename sibling-closure fixture to avoid false test-equivalence hit tools/bazel/equivalence.py line-scans *_test.go files for a column-0 `func Test\w*(t *testing.T)` to build its "what go test runs" list; it reads raw text, not compiled Go, so the fixture's embedded raw-string Go source (used to feed findHostToolExecCalls a parseable AST) was mistaken for a real top-level test the package defines, and the equivalence check failed because no go_test target "ran" it. Rename the fixture function from TestX to siblingClosureFixture, matching the existing convention a few lines down (bazelOnlyFixture) that documents the same pitfall. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| bench-ready-indexes | ||
| check-versions | ||
| checkworkflowtags | ||
| ci | ||
| gitattributespolicy | ||
| hooks | ||
| internal/testbash | ||
| migration-test | ||
| pr-lint | ||
| prlintmake | ||
| repochecks | ||
| repro-be-1he-slow-path | ||
| repro-dolt-hang | ||
| repro-dolt-prod-timeouts | ||
| workflowtags | ||
| bazel-autofix-push.sh | ||
| bazel_autofix_push_test.go | ||
| bazel_cache_mode_test.go | ||
| bazel_dolt_race_shadow_test.go | ||
| bazel_farm_workflow_test.go | ||
| bazel_fork_mode_test.go | ||
| bazel_go_repository_tools_test.go | ||
| bazel_hermetic_cc_test.go | ||
| bazel_invocations_test.go | ||
| bazel_policy_test.go | ||
| bazel_rbe_prewarm_test.go | ||
| bazel_rrc_test.go | ||
| bazel_skip_allowlist_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-winget-portable-alias.sh | ||
| check-workapi-frontend-boundary.sh | ||
| check_build_tags_test.go | ||
| check_doc_freshness_test.go | ||
| check_release_cross_compile_test.go | ||
| check_testing_short_test.go | ||
| check_winget_portable_alias_test.go | ||
| ci_actions_policy_test.go | ||
| ci_analytics_extract_test.go | ||
| ci_analytics_workflow_test.go | ||
| ci_blacksmith_runner_test.go | ||
| ci_f7b_review_test.go | ||
| ci_f7c_advisory_test.go | ||
| ci_merge_queue_test.go | ||
| ci_workflow_apt_get_timeout_test.go | ||
| ci_workflow_core_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 | ||
| embedded_shard_count_test.go | ||
| gen-winres.sh | ||
| generate-cli-docs.sh | ||
| generate-newsletter.py | ||
| generate-newsletter_README.md | ||
| gh-body-lint | ||
| host_tool_exec_policy_test.go | ||
| host_tool_shell_policy_test.go | ||
| host_tools_test.go | ||
| install-hooks.sh | ||
| install.sh | ||
| install_dolt_test.go | ||
| makefile_bazel_primary_test.go | ||
| managed_local_lane_test.go | ||
| migrate-jsonl-to-dolt.sh | ||
| migrate-legacy-to-current.sh | ||
| migration_corpus_bazel_test.go | ||
| mutation-equivalence.sh | ||
| nogo_integration_scan_test.go | ||
| nogo_integration_step_script_test.go | ||
| nogo_lint_policy_test.go | ||
| pinned_shards_helpers_test.go | ||
| pinned_shards_sources_test.go | ||
| pinned_shards_test.go | ||
| pr-preflight.sh | ||
| pr_lanes_bazel_coverage_test.go | ||
| pr_preflight_test.go | ||
| pr_risk_bazel_coverage_test.go | ||
| pre-push-suite.sh | ||
| pre_push_suite_test.go | ||
| proxied_lane_coverage_test.go | ||
| pull_dolt_image_test.go | ||
| rbe_worker_env_test.go | ||
| README.md | ||
| release.sh | ||
| release_script_test.go | ||
| repo_helpers_test.go | ||
| required_suite_test.go | ||
| resolve-docs-bd.sh | ||
| scripts_targets_test.go | ||
| shard_manifest_test.go | ||
| sign-windows.sh | ||
| test-cgo.sh | ||
| test-git-remote.sh | ||
| test-icu-path.sh | ||
| test.sh | ||
| test_script_test.go | ||
| testing_short_tree_test.go | ||
| tracked_files_test.go | ||
| update-nix-vendorhash.sh | ||
| update-versions.sh | ||
| update-winget.sh | ||
| upgrade-smoke-test.sh | ||
| upgrade_smoke_loop_test.go | ||
| verify-cgo.sh | ||
| worker_env_autosync_test.go | ||
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-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.
ci-pr-lint keeps its supported Bash/Make entrypoint but delegates to the
checkout-owned scripts/pr-lint Go driver, which runs nogo (//tools/nogo)
under Bazel natively and cross-configured for windows/amd64 and darwin/arm64
(see engdocs/LINTING.md). This is the same shell-free
lint authority used by bd preflight in a Beads source checkout.
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-go 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.
scripts/check-testing-short.sh (make check-testing-short; CI runs it in
//scripts:go_sources_test) 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
- 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.