Docs
Playbooks

Playbook: Release And Install

Load when moving draft behavior to live, configuring install targets, testing
released behavior, or changing activation/setup/run forms.

Draft And Live

draft is the staging/current workspace authoring state. live is the released
runtime state. A flow is unreleased until a version is released or promoted and
the live/install-shaped path is verified.

Say draft verified when only draft was exercised. Reserve released,
end-user ready, and public ready for live or installation proof.

For installable/public flows, activation/setup proof is not Discover install
proof. Verify the installed or public catalog path before calling the flow ready.

Default Loop

  1. Start with one compact readiness report:
    • breyta flows readiness <slug>
    • breyta flows release-check <slug> --public --marketplace for public paid release gates
  2. Inspect draft/live difference only when the readiness report says it matters:
    • breyta flows diff <slug>
    • breyta flows show <slug> --target live when live already exists
  3. Check bindings and required inputs:
    • breyta flows configure check <slug>
    • breyta flows configure check <slug> --target live --version latest
  4. Prepare live target when required:
    • breyta flows configure <slug> --target live --version latest --set <slot>.conn=<connection-id>
    • use --from-draft only when intentionally copying draft setup to live
  5. Release with an explicit note:
    • breyta flows release <slug> --release-note-file ./release-note.md
  6. Prove live/install behavior:
    • breyta flows run <slug> --target live --interface-id <id> --input '<json>' --wait
    • installation-specific proof should use --installation-id <id> where relevant
  7. Report the live version, run, output, and any install/setup URLs returned by
    the CLI.

Interface Consistency

Manual runs can use --interface-id <id> to select the declared manual
interface explicitly. Flow source may declare at most one manual interface; use
invocation inputs for manual mode choices. HTTP, webhook, and MCP entrypoints
are interfaces, not legacy triggers.

Install Test Matrix

For installable/public flows, prove install-shaped behavior through
breyta flows installations create/configure/enable and
breyta flows run <slug> --installation-id <id> --wait, not author draft
runs. A fresh installation needs an installable source, so run the matrix
right after release/publish and before announcing the app or calling it
end-user ready. For a paid app, use Buyer Test Mode so the matrix consumes
no real buyer entitlement: breyta flows installations create <slug> --buyer-test-source-install --source-workspace-id <ws> --source-flow-slug <slug> from the Buyer Test workspace, then breyta flows run <slug> --buyer-test --installation-id <id> --wait. Cover the surfaces the flow
declares:

  • a fresh installation with minimal configuration completing a run
  • each declared optional integration absent, and separately bound but
    broken; the run must complete and the report must say what was skipped and
    why
  • each declared boolean toggle passed as explicit false, proving the
    opt-out holds
  • malformed values for each constrained text input, proving validation shows
    a truncated attempted-value preview and a bounded option sample; genuinely
    free-form text needs a format or limit error, not an options list

Runs consume the buyer workspace's paid or trial allowance only when they
complete; failed, cancelled, and timed-out runs release their reservation.
Still budget matrix runs deliberately and fix configuration between attempts;
report allowance surprises with breyta feedback send.

Stop When

  • live target configuration is valid
  • representative live/install run succeeded
  • for installable/public flows, the install test matrix passed through
    installation-scoped runs
  • user-facing output or side effects were inspected
  • unresolved install/UI surfaces are named as risks

References

As of Jul 27, 2026