* ci(bazel): auto-push `make bazel-sync` fixes to PR branches bazel.yml's BUILD sync step now writes the BUILD.bazel / MODULE.bazel / MODULE.bazel.lock part of its drift as the bazel-sync-patch artifact (scripts/ci/bazel-sync-patch.sh) and still fails. The new bazel-autofix.yml workflow_run job (on "Bazel" and "PR") applies it with scripts/bazel-autofix-push.sh: a sync commit on same-repo PR branches, an idempotent apply-recipe comment on fork PRs. Same security model as docs-autofix: the write-permission side never checks out or runs PR code, extracts only the two expected regular files, and refuses any patch naming a path outside an anchored allowlist (no hidden or `..` segments, nothing under third_party/) or carrying a mode change, symlink, rename or binary hunk; `git apply --index` and a post-apply check back that up. Reuses the DOCS_AUTOFIX_TOKEN secret for the push. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * build(bazel): add bazel_autofix_push_test.go to scripts_test `make bazel-sync` output, produced by scripts/ci/bazel-sync-patch.sh and applied with scripts/bazel-autofix-push.sh as an end-to-end exercise of the new autofix path. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(ci): harden the bazel and docs autofix push scripts Addresses the security review of the autofix pipeline, identically in scripts/bazel-autofix-push.sh and scripts/docs-autofix-push.sh (the security-critical functions are now shared verbatim): - validate_patch refuses ANY "rename "/"copy " header (the legacy "rename old/new" form slipped past and, on docs-autofix, pushed a scripts.sh -> docs/cli-reference/x.md rename), checks every "index " line whatever its ids, takes creations/deletions/renames from `git apply --summary`, and reads names from `--numstat -z` (which names only the NEW path of a rename; the old comment was wrong). - docs-autofix gains the post-apply staged re-check and a --check mode. - The patch is applied to an index in a bare clone (read-tree + apply --cached + commit-tree): the PR tree never touches the disk. All git calls run with core.hooksPath=/dev/null, GIT_LFS_SKIP_SMUDGE=1. - Push is leased: --force-with-lease=refs/heads/$HEAD_BRANCH:$HEAD_SHA. - The PR must target this repo, and the head branch must be neither protected nor under a ruleset per the GitHub API (fail closed), on top of the name list. - Only a marker comment written by github-actions[bot] is ever edited. - bazel-autofix only pushes files in packages the PR changed (merge-base..head, computed from fetched refs), MODULE files only when go.mod/go.sum/MODULE changed; base-branch drift is left alone and listed, and a patch with nothing attributable gets a comment only. Tests cover each reviewer attack for both scripts (--check and the full flow against a local bare remote and fake gh), the staged check alone with the validator disabled, spoofed comments, protection/ruleset/API errors, the lease, main drift, and symlinked PR trees. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(ci): trigger bazel-autofix on Bazel only; share job-level concurrency - bazel-autofix.yml triggers only on "Bazel": pr.yml never calls bazel.yml, so "PR" runs never carry the artifact, and their completions cancelled real fixes through the workflow-level group. The policy test now requires the triggering workflow to run on pull_request and upload the consumed artifact instead of asserting the false claim. - Both autofix workflows use one job-level concurrency group per head branch (autofix-<head repo>-<head branch>) without cancel-in-progress: skipped runs take no part, and the two bots queue instead of racing. - Base checkouts use persist-credentials: false; docs-autofix extracts only cli-docs-freshness.patch, as a regular file, outside the workspace. - Policy tests for the trigger, concurrency scope, checkout, and the scripts' shared guards (rename/index checks, comment author, lease, protection lookup, index-only apply, hook-free git). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(ci): tighten autofix attribution, circuit breaker and PR selection Re-review follow-ups for the bazel and docs autofix push scripts: - Root package: paths outside any Bazel package (docs/, .github/, README.md, ...) no longer count as changing //:. Only root-level Go and build inputs (*.go, *.s, *.c, *.h, *.bzl, go.mod, go.sum, BUILD.bazel, MODULE.bazel*) make root BUILD.bazel drift the PR's, so main's root drift is not pushed onto a docs-only PR. - Circuit breaker: the head subject is read from the fetched commit (no API), a failed read counts as non-convergent, and the check runs only once the PR's own staged fix is non-empty. A bot head whose remaining drift is main's now gets the "files this PR did not change" comment instead of a wrong "did not converge" one. Same in docs-autofix. - PR selection: several open PRs can share one head branch. bazel picks the one whose number matches the artifact metadata (among PRs already matching head repo/branch/base repo; head sha still verified); without a unique match both scripts skip instead of taking .[0]. - The privileged clone fetches only the head (and, for bazel, base) branch into an init'ed bare partial repo instead of cloning every branch. - docs-autofix job gets timeout-minutes: 10 (it shares a non-cancelling concurrency group with bazel-autofix). Tests: docs-only/README/workflow/Makefile PRs with root drift get no push, a root Go change gets root BUILD.bazel; breaker cases (bot head with own vs main drift, unreadable subject) for both scripts; PR selection by metadata and ambiguity; HEAD_SHA 40-hex guard; staged-check mode arm; a --summary-only validator copy; both workflows' download steps run as written against a fake gh (run-scoped artifact listing, only the named files extracted, symlinked entries refused); timeout asserted for both jobs. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(ci): bazel-autofix requires bash 4; skip its tests on macOS bash 3.2 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * test(ci): skip every autofix script test on bash < 4 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * build(bazel): sync internal/utils BUILD with main Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Gas City Adopt-PR <adopt-pr@gascity.local> 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-autofix-push.sh | ||
| bazel_autofix_push_test.go | ||
| 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 | ||
| upgrade_smoke_loop_test.go | ||
| 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.