roark · docs
docs/glossary.md

Glossary

Definitions for common Roark terms.

Last updated

#Agent Phase

A workflow step that calls the Pi coding-agent SDK, such as planning, implementation, review, or fix.

#Artifact

A durable file written under .roark/runs that records workflow input, output, decisions, validation, or status.

#Attempt

One run of Roark for one issue. Attempts are numbered and stored under .roark/runs/issue/<issue>/attempts/<attempt>/.

#Autorun

The one-shot label-gated workflow invoked by roark auto.

#Control Checkout

The local repository checkout where roark is invoked and where .roark/config.json and .roark/runs live.

#Pull Request

The PR Roark opens after readiness and verification pass.

#Fix Pass

An iteration where Roark applies reviewer findings after implementation and then reruns review.

#Issue Branch

The Git branch used for one issue, normally roark/issue-<number>.

#Invocation

One execution of the Roark CLI, from command start until Roark returns control to its caller, regardless of the command or outcome.

#Managed Workspace

An isolated clone where Roark runs the agent and verification away from the control checkout.

#Readiness Gate

The gate that validates readiness.json and requires its structured decision status to be ready-for-pr.

#PR Review Generation

One immutable local review-pr result under review-<n>, covering a pinned PR head without changing it.

#Revision

A mutation-authorized Roark run that addresses existing pull-request feedback through roark revise-pr.

#Skip Label

A GitHub label that prevents roark auto from selecting an issue.

#Verification Gate

The gate that runs the configured shell command and requires exit code 0.