CLI- og API-referanse

Programmatisk tilgang til BuildStack: dbs-CLI-en, REST-API-et, GitHub Action-en og utgående webhooks. Alt sammen autentiserer med en API key; opprett en i et prosjekts API keys-panel. Se API-nøkler og dbs-CLI-en for det grunnleggende; denne siden er referansen.

Autentisering

Hvert kall bærer API-nøkkelen din som en bearer-token:

Authorization: Bearer dbs_xxxxxxxx

CLI-en leser den fra dbs login --key … eller miljøvariabelen DBS_API_KEY. Nøkler vises én gang og lagres hashet; roter ved å tilbakekalle og opprette en ny.

dbs-CLI-en

# install (or use npx to run without installing)
npm install -g @dalysie-forge/cli

# authenticate
dbs login --key $DBS_API_KEY

# build a project from a local directory
dbs build ./my-app --project PROJECT_ID --format aab

Kjør dbs --help eller dbs <command> --help for den fullstendige, alltid oppdaterte listen over kommandoer og flagg (CLI-en er kilden til sannhet for sin egen referanse).

GitHub Action

Bruk den medfølgende action-en til å bygge fra en arbeidsflyt:

- uses: Dalysie/dalysie-forge/apps/cli/action@develop
  with:
    api-key: ${{ secrets.BUILDSTACK_API_KEY }}
    project: PROJECT_ID
    format: aab

Lagre nøkkelen som en repository-hemmelighet, aldri inline.

REST-API

Base-URL: https://api.mybuildstack.com/api

Å bygge er en toslags flyt: hent et opplastingsmål, PUT kilden din, og start deretter bygget:

# 1. Request an upload target
curl -sX POST https://api.mybuildstack.com/api/projects/PROJECT_ID/source-uploads \
  -H "Authorization: Bearer $DBS_API_KEY"
# → { "uploadUrl": "https://…", "key": "sources/…" }

# 2. Upload your source tarball to the returned URL
curl -sX PUT "$UPLOAD_URL" --data-binary @source.tgz

# 3. Start a signed release build
curl -sX POST https://api.mybuildstack.com/api/projects/PROJECT_ID/builds \
  -H "Authorization: Bearer $DBS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "variant": "release", "format": "aab", "sign": true, "sourceKey": "sources/…" }'
# → { "id": "b_8f2a1c", "status": "queued" }

Poll bygget, eller list opp et prosjekts bygg:

curl -s https://api.mybuildstack.com/api/projects/PROJECT_ID/builds \
  -H "Authorization: Bearer $DBS_API_KEY"

Vanlige byggfelt:

Webhooks

For å reagere på bygg i dine egne systemer, legg til et webhook-endepunkt i prosjektets innstillinger. BuildStack POSTer en hendelse til URL-en din når et bygg endrer tilstand (for eksempel når det er ferdig), slik at du kan utløse en utrulling, varsle en kanal eller oppdatere et dashboard. Leveranser prøves på nytt ved feil.

Kjøre hele arbeidsflyter på BuildStack

Det ovennevnte utløser app-bygg. For å kjøre dine eksisterende GitHub Actions-jobber på BuildStack-compute i stedet for GitHub-hostede runnere, se Kjør GitHub Actions-CI på BuildStack.