spp checks

spp checks <pr | sha> [--json] reads CI for a pull request (its checks), or for a commit given as 7 to 40 hex characters (its check runs). It prints the result, followed by the failing or pending run names. The reading comes from each run's bucket, never from gh's exit code: pending is never a pass, a cancelled run counts as a failure, and runs that all skip read as none. With --json it prints Checks.

Functions¶

run()¶

function run(args): Promise<number>;

Prints CI's reading for a pull request or a commit.

Parameters¶

Returns¶

Promise\<number>

0 whatever the reading (read it from the output); 2 on a usage error, with the usage on stderr. A gh error exits 1 with the reason on stderr.

Example¶

spp checks 264
spp checks 6aa253f --json

Variables¶

USAGE¶

const USAGE: string;

The usage text spp checks --help prints.

usage: spp checks <pr number | pr URL | commit sha> [--json]

Type Aliases¶

CheckRun¶

type CheckRun = object;

One CI run.

Properties¶

Checks¶

type Checks = object;

CI's reading: the --json shape of spp checks.

Properties¶