GitHub Acties

Gebruik de OpenCX CLI in GitHub Actions om inhoud te valideren bij elke push of pull request.

#Basisworkflow

Deze workflow voert content check uit om inhoudsbestanden te valideren, en content gate om afwijkingen ten opzichte van de remote te detecteren.

name: Content CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  content:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: oven-sh/setup-bun@v2

      - name: Inhoud valideren
        run: bunx @opencx/cli content check

      - name: Inhoud gate
        env:
          OPENCX_API_KEY: ${{ secrets.OPENCX_API_KEY }}
        run: bunx @opencx/cli content gate

Beide commando's beëindigen met code 1 bij een fout, dus de workflow faalt automatisch wanneer de inhoud ongeldig is of niet synchroon loopt.

#Alleen-controle Workflow

Als je alleen lokale validatie nodig hebt (geen vergelijking met de remote), kun je de gate-stap overslaan. Dit vereist geen OPENCX_API_KEY.

- name: Inhoud valideren
  run: bunx @opencx/cli content check

#JSON-uitvoer

Gebruik --json voor machineleesbare uitvoer, nuttig voor downstream stappen of aangepaste rapportage.

- name: Inhoud gate (JSON)
  env:
    OPENCX_API_KEY: ${{ secrets.OPENCX_API_KEY }}
  run: bunx @opencx/cli content gate --json

De gate JSON-uitvoer heeft de volgende vorm:

{
  "valid": true,
  "synced": true,
  "check": { "valid": true, "errors": [], "stats": {} },
  "diff": { "hasChanges": false }
}

#Omgevingsvariabelen

Sla OPENCX_API_KEY op als een repository geheim in je GitHub repository-instellingen.