intentic
Create your workspace
Ship and share

Pre-push check

The suite that runs before anything leaves the machine

On this page(3 sections)

Three verbs about one run, because there is one main working tree and so exactly one check. Starting it answers immediately: a suite takes minutes, and a request held open that long dies at the first proxy. Poll for the verdict; the answer names the terminal where it is really happening.

GET/prepush/stateHow the pre-push check is going

The verdict, or the progress so far. Nothing is addressed by id here, because there is one working tree and so exactly one check.

What you send

Nothing. Call it as it is.

What comes back

FieldType
statusWhere the run is"idle" | "running" | "passed" | "failed" … (6)
commandWhat actually ran, echoed here rather…string
startedAtWhen it began, in millisecondsnumber
finishedAtWhen it ended, in millisecondsnumber
exitCodeHow the command exitednumber
timedOutIt was killed for taking too…boolean
sessionThe terminal it runs in, which…string
outputThe end of what it printed,…string
Try itanswered in this tab
curl
curl "$SANDBOX/prepush/state" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.prepush.state();
POST/prepush/runRun the checks before pushing

Starts the suite the workspace runs before anything leaves the machine, and answers immediately. A suite takes minutes, and a request held open that long dies at the first proxy. It runs in a real terminal, so watch it there and poll for the verdict.

What you send

Nothing. Call it as it is.

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/prepush/run" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.prepush.run();
POST/prepush/cancelStop the pre-push check

Kills the run. It settles as cancelled and the push it was gating does not go.

What you send

Nothing. Call it as it is.

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/prepush/cancel" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.prepush.cancel();

Type to search every page, in the docs and the API reference.