feat: add starter formula examples#3248
Open
seanmartinsmith wants to merge 1 commit intogastownhall:mainfrom
Open
feat: add starter formula examples#3248seanmartinsmith wants to merge 1 commit intogastownhall:mainfrom
seanmartinsmith wants to merge 1 commit intogastownhall:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
seanmartinsmith
force-pushed
the
fix/3246-starter-formulas
branch
from
45f9068 to
5de7879
Compare
Add 3 example .formula.toml files to examples/formulas/: - feature-workflow: design, implement, review, merge - release: bump version, test, tag, publish - quick-check: lint, test, build (designed for wisp use) These serve as documentation-by-example and give new users a starting point for creating their own formulas. Closes gastownhall#3246
seanmartinsmith
force-pushed
the
fix/3246-starter-formulas
branch
from
5de7879 to
22a984d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
bd formula listreturns "No formulas found" on a fresh install. The formula system is powerful but no.formula.tomlfiles ship with beads. All examples exist only as doc snippets, giving new users no starting point.Fix
Add
examples/formulas/with 3 starter formulas:Each formula uses features documented in the formulas guide: variables, step dependencies, human-type steps, and parallel-then-join patterns. A README explains how to copy them into project-level or user-level formula directories.
Test Plan
bd formula listshows all 3 formulas when copied to.beads/formulas/bd mol pour feature-workflow --var feature_name=test --dry-runpreviews correctlybd mol pour release --var version=1.0.0 --dry-runpreviews correctlyContext
Closes #3246. The formulas are based on examples already in the docs (
website/versioned_docs/version-1.0.0/workflows/formulas.md) but fleshed out with step descriptions that make them immediately usable.