Ship

How it works

No guide is written for this feature yet. The operations and screens below come straight from the code. The help center has the guides that exist.

What you can do

The operations this feature's screens call. Each one is POST /api/<name>, and the badge says who may call it.

• ship/connect

  Member

  Ship: connect a public GitHub repository (a commit link pins that commit); clone, install and index run in the background.

  Types: { url: string } → returns { repository: ShipRepositoryDto }

• ship/start

  Member

  Ship: send one issue (its GitHub link, its text, or both: the text then counts and the link names the issue) through find, fix, test, verify, deploy and the live check.

  Types: { repositoryId: string; issueUrl?: string; issue?: ShipIssue } → returns { run: ShipRunDto }

• ship/screenshot

  Member

  Ship: the live check's screenshot of a run, as a data URL.

  Types: { id: string; which?: 'before' | 'after' } → returns { dataUrl: string | null }

• ship/status

  Member

  Ship: whether this server runs Ship work, the connected repositories and the latest runs.

  Types: Record<string, never> → returns ShipStatusDto

• ship/run

  Member

  Ship: one run with every stage and its record.

  Types: { id: string } → returns { run: ShipRunDto }

Screens

• /ship

What it records

The feature writes these events to the audit log, the permanent record of what happened.

• Ship repository connected
• Ship run finished
• Ship run started