Files
pipelines/examples/README.md
T
alan e37b864c40 stage turns: replace JSON results with file-based markdown turns
Each model visit now gets <run>/stages/<seq>-<stage>/ with input.md,
memory.md, output.md, private/ and a shared run-level public/. The model
reads the two input files, follows the stage's instructions verbatim and
returns complete markdown; only the # outcome section is parsed.

- add internal/turn layout, render and output parsing
- write input.md/memory.md before a visit and output.md from the final
  message; inventory all turn files as stage artifacts
- accumulate completed turns and system-written public file additions in
  memory, including across retries and resume
- remove the JSON envelope, strict field validation, line format and the
  repair ladder for model stages
- republish pipeline authoring prompts and docs in the new style

Checks: go build ./..., go vet ./..., go test -count=1 ./..., gofmt -l .
2026-10-19 22:27:44 +01:00

75 lines
4.5 KiB
Markdown

# Simple workflow templates
Five optional, technology-neutral starters. Nothing is installed as a published
pipeline automatically; all templates are manual-only and have at most four stages.
| Template key | Workflow | Tools |
| --- | --- | --- |
| `task` | Complete a task, then commit it locally | Work: read/edit/shell and conditional web search/fetch; committer: read/shell |
| `review` | Read repository content and report findings | Read/glob/grep and conditional web search/fetch; no edit/shell |
| `research` | Research a topic, then write a sourced report | Web search/fetch, then none |
| `three-stage` | Plan → implement → review → commit | Planner read/glob/grep + conditional web; implementer read/glob/grep/edit/shell with no web (follows the planner's research); reviewer independent shell + conditional web; committer read/shell |
| `docs-fold` | Fold accumulated item documentation notes into the shared docs, then commit locally | Fold: read/glob/grep/edit/shell; committer: read/shell |
Every workflow that changes the repository ends in a **committer** stage that
commits locally and never pushes. The committer inspects `git status` and the full
diff, stages this run's change (a model-declared list can be incomplete), then runs
the repository's required checks before committing. `task` and `three-stage` follow this;
`review` and `research` change nothing and so do not commit.
`docs-fold` is the deliberate **single documentation writer**. A per-item workflow never
edits a shared README or topic doc: when its change makes one stale it records a note at
`docs/notes/<slug>.md`, unique per item, and commits that note with the change. Running
the manual-only `docs-fold` pipeline later folds the accumulated notes into the shared
documentation and removes them.
Model and agent stages read the turn's `input.md` and `memory.md`, then return the
complete `output.md` markdown. The only required section is `# outcome` followed by
one declared edge word; every other heading is free-form evidence for the next stage
and the operator. See `docs/notes/stage-turns.md`.
Web search/fetch is conditional: stages use it only when a task genuinely needs
external knowledge such as accepted industry approaches, framework or library
APIs, current security/compatibility guidance, or unfamiliar techniques, and they
state why when no research is needed. Trivial, fully understood local edits do not
force web access, and conditional research fails closed only when the required
reliable evidence cannot be obtained, not merely because one search failed. The
`three-stage` implementer has no web tools and works from the planner's research
with local read/edit/shell. The `three-stage` reviewer is an independent quality
gate: it receives the original task and the planner's plan/design/reuse
targets/acceptance checks, inspects the actual changed files and runs its own
checks, returns success only when the applicable acceptance checks were
independently observed passing and no unresolved substantive issue remains, and
otherwise rejects with concrete findings even when a stage reported success.
In the TUI, use `:templates`, choose a starter, and press **s** or Enter on
**Submit template**. Type a name, press Enter to save a retained draft, then
confirm publication. **e Customize** opens the editor picker instead. Canceling
the name prompt creates nothing; canceling publication keeps the saved draft.
CLI equivalent:
```sh
pipelines new "My workflow" --template task --no-open
pipelines drafts
pipelines submit /path/printed/by/new.md
```
New drafts inherit the server's configured default model. The checked-in files
contain a fallback model; direct file submission uses those configs as written.
Provider inference and search availability must be verified on your execution
server. Parsing a definition does not prove its model/tools can run.
Templates do not impose a language, framework, schedule, notification setup or
deployment, and they never push to a remote. Work-producing templates commit
locally through their committer stage; add a schedule, notifications or a
deployment step only when your own workflow requires it.
Editing these source files does not change any installed or published definition;
each starter becomes an immutable version only after explicit authoring and
publication.
Removing a template from this catalog does not delete published versions,
run history, retained drafts, or OpenCode sessions. Nested routing examples used
for renderer regression tests live in `internal/pipeline/testdata`, not this catalog.