Sync flags in CI

Overview

Fieldkit’s web-app repo owns shipd.config.ts. On every PR they fail CI if the file drifted from production. On merge to main they push. Management keys (shipd_mgmt_…) carry org + project + environment. The server rejects a push to a different environment than the key’s binding.

Create the key

In app.useshipd.com create a management API key for fieldkit / web-app / production. Store it as SHIPD_API_KEY. --org (or SHIPD_ORG) must match the key’s organization when set. It cannot switch orgs.

Check drift on PRs

.github/workflows/flags-diff.yml

name: flags-diff
on: pull_request
jobs:
  diff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm
      - run: pnpm add -g @shipdit/cli
      - run: shipd diff --exit-code --project web-app --env production
        env:
          SHIPD_API_KEY: ${{ secrets.SHIPD_API_KEY }}

Exit	Meaning
`0`	No drift
`2`	Creates, updates, or archives pending
`3`	CAS conflict (stale version)
`4`	Unlinked / ownership edge

Push on main

.github/workflows/flags-push.yml

name: flags-push
on:
  push:
    branches: [main]
    paths: ["shipd.config.ts"]
jobs:
  push:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: pnpm add -g @shipdit/cli
      - run: shipd push --yes --project web-app --env production
        env:
          SHIPD_API_KEY: ${{ secrets.SHIPD_API_KEY }}

--ci is the same as --yes. CI=1 or SHIPD_CI=1 also skip confirmation.

SHIPD_API_KEY=shipd_mgmt_… shipd push --yes
# or
shipd push --ci --project web-app --org fieldkit --env production

After a conflict

Error: conflict
exit 3

Someone else applied a newer version. On a developer machine:

shipd pull --project web-app --env production
# re-apply your edits
shipd push --yes

--force overrides CAS and is audited. Prefer pull.

How-to: Push from CI · Resolve a conflict
CLI reference

Getting started

Guides

How-to

Concepts

Reference

Sync flags in CI

Overview

Create the key

Check drift on PRs

Push on main

After a conflict

Next

​Overview

​Create the key

​Check drift on PRs

​Push on main

​After a conflict

​Next

Overview

Create the key

Check drift on PRs

Push on main

After a conflict

Next