beads/examples/formulas
Harry Miller 337903d58c
examples: add GitHub issue-to-PR and PR triage formulas (#3866)
* chore: track workflow formulas for portability

Force-add gh-issue-to-pr and gh-pr-review formulas so they can be
cloned to new machines. These live in .beads/formulas/ which is
normally gitignored, but formulas are code (not database state).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: untrack workflow formulas

Remove gh-issue-to-pr and gh-pr-review formulas from git tracking.
These are already covered by .gitignore (.beads/) and shouldn't be
sent upstream.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* examples: add GitHub issue-to-PR and PR triage starter formulas

Ship reusable GitHub automation examples and remove hard-coded beads-specific defaults so teams can adapt them to their own repositories.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-14 10:53:23 -07: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 examples: add GitHub issue-to-PR and PR triage formulas (#3866) 2026-05-14 10:53:23 -07:00
gh-pr-review.formula.toml examples: add GitHub issue-to-PR and PR triage formulas (#3866) 2026-05-14 10:53:23 -07:00
quick-check.formula.toml feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00
README.md examples: add GitHub issue-to-PR and PR triage formulas (#3866) 2026-05-14 10:53:23 -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.