* perf(dolt): be-1he eliminate 12s `dolt remote -v` against multi-db server roots Three layers of defense for the bd 12s slow-path bug: - Layer 1: migrateServerRootRemotes skips when rootDir/.dolt/repo_state.json is missing. Multi-database server roots have only sql-server.info; running `dolt remote -v` there takes ~12s to fail. - Layer 2: ListCLIRemotes wraps the dolt subprocess in a 2s context timeout. Backstops Layer 1 against any future variant of the broken-parent-dir case. - Layer 3: autoMigrateOnVersionBump does a read-only probe of bd_version before opening writeable. Read-only stores skip syncCLIRemotesToSQL, so a stale .local_version (e.g. from a multi-binary install) no longer triggers the slow path on every command. End-user impact pre-fix: gc mail inbox 60-80s, gc status 30s+ hangs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore: release gate PASS for be-1he (3-layer slow-path fix) * docs(repro): add be-1he slow-path repro script (be-vxngmn) Adds scripts/repro-be-1he-slow-path/repro.sh + REPRO.md demonstrating the 12-second `dolt remote -v` slow path on multi-DB server roots. Satisfies coffeegoddd's review request: "We need a beads-only repro of this to prove its a bug." Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(cli): regenerate CLI reference after slow-path fix rebase Output of ./scripts/generate-cli-docs.sh ./bd and ./scripts/generate-llms-full.sh. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(cli): regenerate CLI reference + llms-full with pure-go bd The previous regen (0aeb5934e) was built with a CGO-enabled bd, which includes the CGO-only `bd federation` subcommands. CI builds the docs binary with CGO_ENABLED=0 (scripts/ci/pr-policy.sh build_docs_binary), so check-doc-flags rejected the extra federation subcommand pages. Regenerated docs/CLI_REFERENCE.md, the federation cli-reference pages (live + versioned 1.0.0/1.0.4/1.0.5), and website/static/llms-full.txt with a CGO_ENABLED=0 binary. check-doc-flags + check-doc-freshness now pass locally under LC_ALL=C. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(release-gate): correct be-1he layer description to match shipped diff The PR body and this gate doc both described a "Layer 1" repo_state.json sentinel in internal/storage/dolt/federation.go, but the actual diff never touched that file - only cmd/bd/version_tracking.go (Layer 3) and internal/storage/doltutil/remotes.go (Layer 2) are changed. Correct the gate doc's commit table, acceptance-criteria row, and follow-up/out-of-scope notes to describe only what ships. No code or test changes; Layer 2 and Layer 3 remain independently verified as still-needed on current main (ListCLIRemotes has no timeout, no equivalent sentinel exists). Agent-Signature: claude-sonnet-medium on behalf of maphew * fix(dolt): scope ListCLIRemotes timeout, fix repro.sh, purge Layer 1 narrative Addresses the cross-vendor review's four should-fixes plus the comment nit (gastownhall/beads#3710 review, 2026-07-24): 1. ListCLIRemotes' 2s cap could turn a slow-but-valid dolt remote -v into "remote absent": FindCLIRemote folds any error (including a timeout) into "", and EnsureCLIRemote then blind-adds on that signal, which hard-fails if the remote actually exists. Chose the "scope the cap" fix over "propagate DeadlineExceeded distinctly": it's fully contained inside ListCLIRemotes (no changes needed at the three call sites - remotes.go:192 ensure-path, store.go:1958 URL match via hasMatchingCLIRemote, and doctor/federation.go:127, which already treats errors distinctly from "no remotes"), whereas threading a sentinel error type through FindCLIRemote's string-returning signature and its callers touches more surface for the same outcome. ListCLIRemotes now stats dbPath/.dolt/repo_state.json: 2s cap when absent (the known broken multi-DB server-root case - there's never a real answer coming from there), 30s cap otherwise (a real repo's `dolt remote -v` is ~130ms even loaded, so 30s only bites a genuinely hung subprocess). Added TestListCLIRemotesTimeout covering both branches, following the t.TempDir() pattern already used in persisted_remotes_test.go. 2. repro.sh's baseline `dolt remote -v` ran in the invocation directory, not $SERVER_ROOT, so the central "slow" measurement never exercised the constructed broken root. Fixed to `(cd "$SERVER_ROOT" && dolt remote -v 2>&1) || true`, matching the correct subshell pattern already used later in the script. Also relabeled the "PARTIAL FIX ... Layer 2 timeout capped it" branch: the 2s cap lives in bd's Go code, not dolt, and this script calls the raw dolt binary directly - it's never capped. Relabeled to describe the underlying dolt slowness the script demonstrates instead of implying bd's timeout is in play here. 3. `dolt init --quiet` isn't supported by dolt 2.2.x and set -e killed the script before it reached the summary. Redirected output instead (`dolt init >/dev/null 2>&1`). Ran repro.sh end-to-end locally (dolt 2.2.0): completes with exit 0, and the fixed subshell now shows real timing/output from inside $SERVER_ROOT. 4. Purged the unshipped "Layer 1" (federation.go sentinel) narrative from repro.sh and REPRO.md - same reconciliation already done for the release gate doc and PR body. Both files now describe only the two layers that ship (remotes.go timeout, version_tracking.go read-only probe), with a short note that an earlier draft described a Layer 1 that never landed. 5. cmd/bd/version_tracking.go:195-197 comment cited syncCLIRemotesToSQL, which doesn't exist anywhere in the tree, and overstated the read-only probe's benefit. On current main the writeable-open gate reads remotes via doltutil.PersistedRemotes (a fast on-disk repo_state.json probe, no dolt subprocess), so the probe saves an initSchema round-trip, not a 12s hang. Corrected. Agent-Signature: claude-sonnet-medium on behalf of maphew --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: matt wilkie <maphew@gmail.com> |
||
|---|---|---|
| .. | ||
| bench-ready-indexes | ||
| ci | ||
| hooks | ||
| migration-test | ||
| repro-be-1he-slow-path | ||
| repro-dolt-hang | ||
| repro-dolt-prod-timeouts | ||
| 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 | ||
| clean-test-tmp.sh | ||
| conformance.sh | ||
| 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 | ||
| install-hooks.sh | ||
| install.sh | ||
| migrate-jsonl-to-dolt.sh | ||
| migrate-sqlite-to-current.sh | ||
| pr-preflight.sh | ||
| pr_preflight_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 | ||
| 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.
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.