GitHub Actions

GitHub Actions authenticates with a project-scoped deploy token. The token fixes the target project, so the workflow does not use .orbitpush/project.json.

Create a deploy token

1. Open OrbitPush and select your project.
2. Open Deploy tokens and create a token for GitHub Actions.
3. Copy the token when OrbitPush displays it.

Treat the token like a password. It can deploy to that project without an interactive login.

Add the repository secret

Open your GitHub repository and go to Settings → Secrets and variables → Actions. Create a repository secret named ORBITPUSH_DEPLOY_TOKEN and paste the deploy token as its value.

GitHub environment and organization secrets also work if your repository already uses them.

Add the workflow

Create .github/workflows/deploy.yml:

name: Deploy to OrbitPush

on:
  push:
    branches: [main]

permissions:
  contents: read

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-node@v6
        with:
          node-version: 24

      - run: npm ci
      - run: npm run build

      - name: Deploy to OrbitPush
        run: npx -y @orbitpush/cli@latest deploy ./dist
        env:
          ORBITPUSH_DEPLOY_TOKEN: ${{ secrets.ORBITPUSH_DEPLOY_TOKEN }}

Change npm ci, npm run build, and ./dist to match your project. Change main if your production branch has another name.

The deploy step runs only after the preceding install and build steps succeed.

Add OrbitPush to an existing workflow

If your workflow already builds the site, add this step after the build:

- name: Deploy to OrbitPush
  run: npx -y @orbitpush/cli@latest deploy ./dist
  env:
    ORBITPUSH_DEPLOY_TOKEN: ${{ secrets.ORBITPUSH_DEPLOY_TOKEN }}

Replace ./dist with the directory containing the finished static files. An invalid deploy token stops the deployment and never falls back to interactive login credentials.