beads/examples/formulas
Julian Knutsen 47eb06e66a docs(bazel): make bazel test the primary build and test path (ga-96smfk.23)
Bazel is beads' build and test system: bazel.yml's lanes gate every PR,
and nogo (lint + vet), gofmt and the repository guards exist only as
Bazel targets. The docs, the Makefile and the hooks now say so.

Makefile: `make test` runs bazel.yml's test lane (`bazel test //...
--config=ci`), `make check` adds the testing.Short policy and the
`make ci-pr-lint` nogo gate, and `make check-docs` runs the docsync and
doc-freshness Bazel targets before the pinned-release CLI flag check.
BAZEL_FLAGS passes --config=fork-cache or --config=remote-exec through.
The plain-Go recipes stay as explicit twins: test-go, check-go,
check-docs-go. No workflow called the primary names, and
TestWorkflowsNameTheirTestEngine keeps it that way.

Hooks: pre-push runs scripts/pre-push-suite.sh for branch pushes whose
commits change Go or Bazel inputs: the test lane with
--config=remote-exec when some rc names an executor, else
--config=fork-cache. Without bazel, or with BD_PREPUSH_SUITE=go, it runs
make test-go under a banner saying that is not what CI gates on.

Docs: AGENTS.md, CONTRIBUTING.md, engdocs/TESTING.md (a per-lane command
table and the fork-cache/remote-exec setup), README, RELEASING, the PR
template and the .bazelrc header. Bazelisk is a required prerequisite;
go test is an inner-loop convenience CI does not enforce.

Agent-Signature: claude-code-claude-opus-5-5-unknown-reasoning on behalf of Julian Knutsen
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-07 07:12:47 +00:00
..
primitives docs(bazel): make bazel test the primary build and test path (ga-96smfk.23) 2026-10-07 07:12:47 +00:00
feature-workflow.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00
gh-issue-to-pr.formula.toml docs(lint): align contributor guidance with CI (saa-90w) (#5317) 2026-08-07 05:37:12 -07:00
gh-pr-review.formula.toml docs(lint): align contributor guidance with CI (saa-90w) (#5317) 2026-08-07 05:37:12 -07:00
quick-check.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00
README.md docs: redirect legacy GitHub Pages site to Mintlify (#4759) 2026-07-13 14:19:13 -07:00
release.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00

Starter Formulas

Example .formula.toml files you can use as starting points.

Usage

Copy formulas to your project or user-level directory:

# Project-level (available in this project only)
cp *.formula.toml /path/to/project/.beads/formulas/

# User-level (available in all projects)
cp *.formula.toml ~/.beads/formulas/

Then list and use them:

bd formula list        # See available formulas
bd mol pour release --var version=1.2.0   # Pour into a molecule

For advanced GitHub workflows like gh-issue-to-pr and gh-pr-review, customize repo variables (repo, remotes, base branch) and quality-gate commands to match your project before first use.

Included Formulas

Formula Description Use as
feature-workflow Design, implement, review, merge Molecule (persistent)
gh-issue-to-pr Triage a GitHub issue through implementation and PR creation Wisp (ephemeral)
gh-pr-review Triage and review a GitHub PR using maintainer guidelines Wisp (ephemeral)
release Bump version, test, tag, publish Molecule (persistent)
quick-check Lint, test, build sanity check Wisp (ephemeral)

Creating Your Own

See the Formulas documentation for the full reference.