Docs / Configuration

ShipGlance is free. Sign in with GitHub, install the App, and your board is live. Sign up free →

Configure a GitHub Actions deployment board

Configuration on ShipGlance is UI-first. A code-managed mode is optional. Both modes are validated by the same rules.

How is a board configured by default?

By default, ShipGlance generates your configuration from repository discovery and your plan, and you adjust it in the console. You never edit a file. Settings → Export as YAML gives you the current applied configuration at any time. Start with the quickstart.

Can I manage configuration in code?

Yes. Point your workspace at a YAML file in a connected repository (Settings → Configuration mode: repository, file path, branch). From then on:

• Every push to that file is validated and applied automatically.
• A rejected push never half-applies. Your board keeps running the last good configuration, and the console shows the rejection reason.
• The settings UI becomes read-only and names the source file.
• Switching back to UI-managed stops reading the file. Nothing is merged and nothing is deleted from your repository.

What can a code-managed file set?

Your file owns the monitoring semantics: providers, workflows, views, notifiers, redaction, history, shares, and wall. Credentials, hosting, and storage are managed by the service and are not customer-settable. Anything not listed as customer-settable here is managed by the service and is rejected by name, never silently stripped. A notifier's credential is referenced by environment-variable name (tokenEnv) and provisioned by the service: a secret never appears in your file.

What happens when a file exceeds my plan?

Plan limits are rejected, not clamped. A push that exceeds a limit fails with an error naming the limit; ShipGlance never quietly applies less than your file says.

• Workflows: 20.
• GitHub connections: 3.
• History retention: up to 14 days.

Those are the free plan's limits, and the free plan is what everyone is on today. Paid plans with higher limits are coming; your workspace settings will show them when they arrive.

What does a minimal file look like?

providers:
  acme-org:
    kind: github

workflows:
  - id: api
    name: acme/api
    repo: acme/api
    workflow: .github/workflows/ci.yml
    branch: main
    provider: acme-org
    stages:
      - key: prod
        label: Production
        job: deploy-prod
        deploy: true
        env: prod

history:
  enabled: true
  retention: 2160h   # 90 days

A file that would not apply cleanly never becomes your configuration. See the guides for worked examples, or sign up free.