spp status

spp status <epic> [--json] prints every Sub-issue of an Epic with its state, grouped by Layer, from one GraphQL query. Each line is the ticket's state, its number and title, and its pull request when it has one; a blocking cycle gets a group of its own. The Epic's Fix pull requests (trusted pull requests into its integration branch that close no Sub-issue, open or merged) follow under Fixes, one line each with its state, its number and the Sub-issue its Refs line names or unattributed, and the header line ends with the open count, as in (3 fixes open); with no fixes it prints neither. With --json it prints the whole EpicState instead, the fixes as fixes.

Functions¶

run()¶

function run(args): Promise<number>;

Prints the Epic's state.

Parameters¶

Returns¶

Promise\<number>

0 when it printed the state; 2 on a usage error, with the usage on stderr. A gh error exits 1 with the reason on stderr.

Example¶

spp status 197
spp status https://github.com/syn54x/skills-plus-plus/issues/197 --json

Variables¶

USAGE¶

const USAGE: string;

The usage text spp status --help prints.

usage: spp status <epic number | issue URL> [--json]

Type Aliases¶

TicketState¶

type TicketState = 
  | "blocked"
  | "ready"
  | "claimed"
  | "pr-open"
  | "gate-pass"
  | "gate-fail"
  | "merged"
  | "handed-back"
  | "not-agent";

Where a Sub-issue stands, the first that fits: merged (the issue is closed), handed-back (unheld, with a route label; blocked beside ready-for-agent is not one, since that route waits on its blocked-by edge), pr-open, gate-pass or gate-fail (an open pull request, by the slice gate's verdict on its current head), claimed (held by the Claim mark or an assignee), blocked (an open blocker that has not landed), not-agent (no ready-for-agent label), else ready.

Ticket¶

type Ticket = object;

One Sub-issue of the Epic.

Properties¶

Fix¶

type Fix = object;

A Fix pull request: a trusted author's pull request into the Epic's integration branch that closes no Sub-issue, open or merged (ADR 0011). ticket is the URL of the Sub-issue its body's first Refs line names, or null when it names none of them (unattributed).

Properties¶

EpicState¶

type EpicState = object;

An Epic and its Sub-issues as one snapshot derives them: the --json shape of spp status.

Properties¶

PrState¶

type PrState = "OPEN" | "MERGED" | "CLOSED";

A pull request's state on GitHub.

Pr¶

type Pr = object;

A pull request linked to a Sub-issue.

Properties¶

Verdict¶

type Verdict = object;

The slice gate's verdict on one head of a pull request, as its <!-- spp-verdict --> comment's trailer holds it.

Properties¶