Skip to content

Developers

CI/CD integration

Trigger governed validation from GitHub Actions, GitLab CI, Jenkins, and more.

Overview

Trigger governed validation from GitHub Actions, GitLab CI, Jenkins, Azure DevOps, or any runner that can invoke curl or the Zof CLI. Fail the pipeline when critical cases fail or pass rate drops below threshold.

Prerequisites

  • ZOF_API_KEY and ZOF_PROJECT_ID as CI secrets
  • Network egress from runner to api.zof.ai

Step-by-step procedure

Create API key

Admin → Developer with runs:create permission scope.

Add pipeline step

Install CLI or curl POST /v1/runs.

Pass environment matching deployment target.

Gate on outcome

Poll run status or use zof run --wait.

Fail job on failed or error status.

GitHub Actions

name: Zof Validation
on: [pull_request]
jobs:
  zof:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Install the Zof CLI provided for your deployment. Contact Zof for access.
      - run: zof run --wait --env staging
        env:
          ZOF_API_KEY: ${{ secrets.ZOF_API_KEY }}
          ZOF_PROJECT_ID: ${{ secrets.ZOF_PROJECT_ID }}

Make the pipeline decision unambiguous

Define which source revision and environment the validation covers and which conditions allow the pipeline to proceed. Distinguish an actual passing result from a skipped job, an unavailable executor, an incomplete result, and an integration error.

Test cancellation, repeated events, and stale results before making validation a required release dependency. Keep untrusted pull-request code away from production credentials, and verify the supported integration method rather than assuming a named action or plugin is available.

Was this page helpful?