beads/scripts
Julian Knutsen dbb6df7e9f
fix(schema): CLI bundle never got migration 0065's wisp_comments widening (ga-61ruw) (#5910)
* fix(schema): CLI bundle never got migration 0065's wisp_comments widening (ga-61ruw)

Second and last live instance of the class #5903 fixed for 0060: the Dolt CLI
batch path silently no-ops a PREPARE'd ALTER TABLE while EXECUTE reports
success (dolthub/dolt#11345, fixed in 2.3.0 — but the CLI is pinned to 2.2.0
by #5894 because 2.3.0 broke DOLT_RESET). So 0065's wisp_comments.text
TEXT->LONGTEXT widening never reached the fresh-schema bundle.

Measured, not argued. Applying AllMigrationsSQL() through dolt 2.1.8, 2.2.0
(the pinned CLI) and 2.3.1 and diffing information_schema — with wisp_ tables
INCLUDED, unlike the parity oracle — produced exactly one difference on main
@825cd4c9:

    column|wisp_comments|004|text|text|NO      (2.1.8, 2.2.0)
    column|wisp_comments|004|text|longtext|NO  (2.3.1)

After this change all three agree on all 504 lines. 2.1.8 and 2.2.0 are
byte-identical to each other, so the host CLI is a faithful stand-in for the
pinned one.

WHY THE OBVIOUS FIX FAILED, AND WHAT REPLACES IT. A bare direct MODIFY was
tried before and backed out: it reproduces as
`error ... ALTER TABLE wisp_comments MODIFY COLUMN text LONGTEXT NOT NULL:
table not found: wisp_comments` inside
TestFullChainFromPreWispsAndMissingDependenciesIDConvergesThroughDoltCLI,
which replays the substitution over a database that never synced the
clone-local wisp tables (#4695/#4176) and whose 0047 repair recreates only
wisps and wisp_dependencies.

The substitution surface now says so out loud. cliSubstituteAssumesWispTables
names the substitutes that presume the wisp tables exist — 0053, which the
full-chain test already special-cased by version number, and now 0065. Replay
callers use the frozen source text, whose own PREPARE guard no-ops correctly
because an INFORMATION_SCHEMA probe for a missing table yields NULL and
IF(NULL = 1, ...) takes the 'SELECT 1' branch.
TestMigration0065NoopsWithoutWispCommentsThroughDoltCLI pins that, with the
direct substitute failing on the same database as its control.

CLOSING THE CLASS. 0060 and 0065 were both found by accident, six days apart,
because nothing looks for this shape: check-migration-hygiene.sh check E flags
prepared DML, not prepared ALTER, and the parity oracle excludes wisp_ tables
by name. internal/storage/schema/cli_prepared_ddl.go adds
TestBundleMigrationsWithPreparedALTERAreOverriddenOrJustified: it scans the
substituted bundle text for prepared ALTER TABLE and requires each hit to have
either a direct-DDL override or an entry in preparedALTERSafeOnFreshBundle
with a written reason. No Dolt binary is involved, so a CLI upgrade cannot
mask it the way it masked the oracle.

Mutation-verified end to end. A synthetic 0066 with a prepared ALTER and no
override makes the guard fail with a message naming the file and statement;
the same bundle really does drift (issues.storage_class varchar(16) on 2.2.0
vs varchar(32) on 2.3.1); adding an override makes it pass; removing the
migration returns green. Removing 0065's override reds both the new guard and
the #5903-style string assertion.

The seven grandfathered entries were measured the same way — build the bundle
truncated to just before migration N, apply N's frozen text on 2.3.1 where
prepared DDL always executes, diff. Six change nothing (their guards do not
fire on a fresh database); 0050's guard does fire, but ALTER COLUMN ... DROP
DEFAULT is one of the forms that executes on 2.2.0. 0065's own text moves that
diff, which is the control proving the six empty diffs mean something.

Probed subcommand split on 2.1.8, with a direct ALTER as the must-land
control: ADD COLUMN, MODIFY COLUMN, DROP COLUMN and ADD PRIMARY KEY vanish;
DROP DEFAULT, RENAME COLUMN, ADD/DROP INDEX, ADD CONSTRAINT, CREATE INDEX,
RENAME TABLE and CALL all execute. The guard flags every prepared ALTER TABLE
anyway — over-flagging costs one justified inventory entry and avoids guessing
about forms nobody probed.

NOT WIDENING THE PARITY ORACLE, and here is the evidence rather than a
shrug. AllMigrationsSQL() walks the main series only, and there is no
ignored-series bundle to pair with it. Applying bundle-only vs
bundle-plus-ignored-series through 2.3.1, the ignored plane owns
wisps.is_blocked (+ two indexes), the dropped uuid() defaults on
wisp_comments/wisp_dependencies/wisp_events .id, wisp_events.old_value and
new_value as LONGTEXT, leases.granted_node and ignored_schema_migrations
itself. Every one would read as a spurious "only in runtime" line, so covering
the ephemeral plane means building an ignored-series bundle, not deleting a
predicate. That analysis is now recorded in the oracle's own comment.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* test(dolt): stop the argv-limit test depending on the migration bundle's size

TestRunDoltSQLHandlesLargeScript asserted that schema.AllMigrationsSQL()
exceeds Linux's MAX_ARG_STRLEN (131072 bytes), so that the script it pipes
really does exercise the argv path. That precondition is the right idea and
the wrong measurement: the bundle's size is an accident of migration content.
Registering 0065's direct-DDL override in the previous commit REPLACED a
~2.4KB guarded PREPARE block with a 62-byte statement and took the bundle from
132601 to 130281 bytes, so the test went red on Linux and macOS for a reason
with nothing to do with argv. Every future override shrinks it again; every
future migration grows it back.

Build a script that is definitely oversized instead of hoping. padPastArgvLimit
appends SELECT 1; statements — which the CLI still has to parse — until the
script clears the limit, and leaves an already-oversized script alone. The
precondition assertion stays, now covering the padded script, so a broken
helper cannot quietly leave the test passing on a script that would have fit
in argv.

TestPadPastArgvLimit is the control for that helper, across empty, just-under,
exactly-at and already-over inputs. Mutation-verified: stubbing the padding out
reds it on every under-limit case.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-20 23:38:48 -07:00
..
bench-ready-indexes feat: choose your own storage backend (Postgres / MySQL / SQLite) — rebased on main 2026-07-10 17:44:37 +00:00
ci fix(ci): pin the Dolt CLI — 2.3.0 broke DOLT_RESET on fresh databases (ga-m0dlk) (#5894) 2026-08-20 20:59:27 -07:00
gitattributespolicy build: make repository text EOL deterministic (#5319) 2026-08-10 20:48:09 -07:00
hooks feat: Add post-push hook to auto-install bd CLI after git push 2025-10-14 17:23:43 -07:00
migration-test Pin authenticated historical release catalog (#5100) 2026-08-18 12:25:44 -07:00
prlintmake fix(ci): remove recursive Make from lint formatting (#5302) (#5320) 2026-08-10 21:43:59 -07:00
repro-be-1he-slow-path perf(dolt): eliminate 12s slow path on bd commands when .local_version is stale (#3710) 2026-07-24 00:53:06 -07:00
repro-dolt-hang /{cmd,internal,scripts}: use dsn helpers 2026-04-06 15:56:37 -07:00
repro-dolt-prod-timeouts fix(scripts): scrub Windows env keys case-insensitively (#5534) (#5609) 2026-08-10 23:45:33 -07:00
build-examples.sh fix(examples): tidy both example modules and build them in CI (#5229) 2026-08-12 21:16:27 -07:00
bump-version.sh refactor: replace bump-version.sh with molecule pointer 2026-01-14 21:53:06 -08:00
check-build-tags.sh docs: move internal/maintainer docs from docs/ to engdocs/ 2026-07-12 10:37:07 -07:00
check-cli-docs-drift.sh docs(pipeline): pin the CLI docs to the released bd; repair main's broken CLI reference (#4876) 2026-07-17 18:03:28 -07:00
check-doc-flags.sh sync: name a resolve command on conflict, fix -q asymmetry, close doc-flags hole, cover runSyncCommand (wy-j6q2z) 2026-07-25 19:28:31 -07:00
check-doc-freshness.sh Validate doc freshness max age (#5524) (#5606) 2026-08-10 21:02:23 -07:00
check-go-install-guidance.sh fix(install): use declared module path for go fallback (#4215) 2026-05-27 21:48:24 -07:00
check-migration-hygiene.sh fix(schema): CLI bundle never got migration 0065's wisp_comments widening (ga-61ruw) (#5910) 2026-08-20 23:38:48 -07:00
check-testing-short.sh Fix: check-testing-short.sh flags comments and misnames the offending function (round 2) (#5809) 2026-08-19 21:01:15 -07:00
check-versions.sh fix(release): version bumps now own the tracked .githooks markers 2026-08-11 14:06:28 -07:00
check_doc_freshness_test.go Validate doc freshness max age (#5524) (#5606) 2026-08-10 21:02:23 -07:00
check_testing_short_test.go Fix: check-testing-short.sh flags comments and misnames the offending function (round 2) (#5809) 2026-08-19 21:01:15 -07:00
ci_capability_selector_test.go ci: PR-CI lane runs the full internal/storage/dolt suite against a live Dolt server (#5836) 2026-08-19 20:39:38 -07:00
ci_workflow_apt_get_timeout_test.go fix: bound and retry apt-get calls in CI to avoid unbounded 15-minute job timeout (#5810) 2026-08-19 11:47:22 -07:00
ci_workflow_test.go fix(ci): pin the Dolt CLI — 2.3.0 broke DOLT_RESET on fresh databases (ga-m0dlk) (#5894) 2026-08-20 20:59:27 -07:00
clean-test-tmp.sh test(cmd/bd): route sync.Once test temp dirs through TestMain cleanup (#4108) 2026-05-22 16:48:22 -07:00
conformance.sh ci: give conformance explicit timeout budgets (#5073) 2026-07-28 09:01:39 -07:00
conformance_script_test.go test(scripts): stabilize Git Bash shim paths (saa-cgh.55) (#5465) 2026-08-09 01:05:13 -07:00
cross-version-smoke-test.sh docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
docs-autofix-push.sh chore: purge deleted docs-pipeline references from release tooling, CI, and repo plumbing 2026-07-12 11:07:26 -07:00
docs.md Validate doc freshness max age (#5524) (#5606) 2026-08-10 21:02:23 -07:00
gen-winres.sh chore: re-land v1.1.0-rc.1 release prep (#4486) 2026-06-25 20:10:18 -07:00
generate-cli-docs.sh docs(pipeline): pin the CLI docs to the released bd; repair main's broken CLI reference (#4876) 2026-07-17 18:03:28 -07:00
generate-newsletter.py Newsletter generator: automated narrative summaries of releases 2026-01-22 16:09:29 -08:00
generate-newsletter_README.md Newsletter generator: automated narrative summaries of releases 2026-01-22 16:09:29 -08:00
gh-body-lint docs: align agent maintainer conventions (#4237) 2026-06-20 20:44:08 -07:00
install-hooks.sh feat: Add post-push hook to auto-install bd CLI after git push 2025-10-14 17:23:43 -07:00
install.sh docs(ci): add Mintlify preview, docsync guard, and broken-links workflow 2026-07-12 10:37:07 -07:00
migrate-jsonl-to-dolt.sh feat: add JSONL-to-Dolt migration script (GH#2276) 2026-03-02 22:05:38 -08:00
migrate-legacy-to-current.sh Guard and qualify historical upgrades to v1.2 (#4907) 2026-08-06 18:45:04 -07:00
mutation-equivalence.sh Fix a SIGPIPE in the mutation harness's worktree guard (#5434) 2026-08-08 08:28:08 -07:00
pr-preflight.sh fix(pr-preflight): warn when a PR-gate workflow is red for every PR while the base shows green (#5251) 2026-08-01 22:46:44 -07:00
pr_preflight_test.go fix(pr-preflight): warn when a PR-gate workflow is red for every PR while the base shows green (#5251) 2026-08-01 22:46:44 -07:00
pull_dolt_image_test.go ci: PR-CI lane runs the full internal/storage/dolt suite against a live Dolt server (#5836) 2026-08-19 20:39:38 -07:00
README.md fix(pr-preflight): warn when a PR-gate workflow is red for every PR while the base shows green (#5251) 2026-08-01 22:46:44 -07:00
release.sh fix(release): harden shipped release formula adoption (#3668) 2026-05-06 12:14:54 -07:00
release_script_test.go test(scripts): stabilize Git Bash shim paths (saa-cgh.55) (#5465) 2026-08-09 01:05:13 -07:00
resolve-docs-bd.sh docs(pipeline): pin the CLI docs to the released bd; repair main's broken CLI reference (#4876) 2026-07-17 18:03:28 -07:00
sign-windows.sh docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
test-cgo.sh Rename ICU-only test path to explicit opt-in workflow (bd-b18) (#3291) 2026-04-16 08:54:24 -07:00
test-git-remote.sh /{.github,docs,engdocs,go,internal,scripts}: bump dolt 2026-07-15 13:14:34 -07:00
test-icu-path.sh Rename ICU-only test path to explicit opt-in workflow (bd-b18) (#3291) 2026-04-16 08:54:24 -07:00
test.sh fix: export the native prebuilt test binary path (#5512) 2026-08-10 05:31:23 -07:00
test_script_test.go test(scripts): report helper-only probe as skipped (#5599) 2026-08-10 20:58:58 -07:00
update-nix-vendorhash.sh feat: comprehensive NixOS support improvements (#1024) 2026-01-12 23:46:33 -08:00
update-versions.sh fix(release): version bumps now own the tracked .githooks markers 2026-08-11 14:06:28 -07:00
update-winget.sh docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
upgrade-smoke-test.sh test(upgrade-smoke): exercise dependency blocker paths on migrated DB (#4238) 2026-05-28 15:30:21 -07:00
verify-cgo.sh fix: remove ICU runtime dependency from release binaries (#3066) 2026-04-07 09:48:44 -07:00

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-mcp builds or consumes a bd binary, puts it on PATH as bd, then runs locked MCP package uv sync, Ruff, mypy, pytest, and build checks.
  • make ci-package-npm builds or consumes the native binary expected by npm-package/bin/bd, runs the npm package test suite, and checks npm 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:

  1. ✅ Stops running Dolt servers (avoids version conflicts)
  2. ✅ Runs tests and linting
  3. ✅ Bumps version in all files
  4. ✅ Commits and pushes version bump
  5. ✅ Creates and pushes git tag
  6. ✅ Verifies or opens the Homebrew core formula PR
  7. ✅ Upgrades local Homebrew installation
  8. ✅ 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 beads to 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 constant
  • plugins/beads/.claude-plugin/plugin.json - Claude plugin version
  • plugins/beads/.codex-plugin/plugin.json - Codex plugin version
  • .claude-plugin/marketplace.json - Claude marketplace plugin version
  • integrations/beads-mcp/pyproject.toml - MCP server version
  • README.md - Alpha status version
  • PLUGIN.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:

  1. Decodes the PFX certificate from base64
  2. Signs the Windows executable using osslsigncode
  3. Timestamps the signature using DigiCert's RFC3161 server
  4. Replaces the original binary with the signed version
  5. Verifies the signature was applied correctly

Prerequisites

  • osslsigncode installed (apt install osslsigncode or brew install osslsigncode)
  • EV code signing certificate exported as PFX file
  • GitHub secrets configured:
    • WINDOWS_SIGNING_CERT_PFX_BASE64 - base64-encoded PFX file
    • WINDOWS_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.