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.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- ZOF_API_KEY and ZOF_PROJECT_ID as CI secrets
- Network egress from runner to api.zof.ai
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
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.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
Best practices
- Validate changes in staging before applying release gates to production.
- Include run IDs and timestamps when escalating issues to support or auditors.
- Align internal runbook terminology with Zof Console UI labels for clarity.
GitHub Actions
name: Zof Validation
on: [pull_request]
jobs:
zof:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: npm install -g @zof-ai/cli
- run: zof run --wait --env staging
env:
ZOF_API_KEY: ${{ secrets.ZOF_API_KEY }}
ZOF_PROJECT_ID: ${{ secrets.ZOF_PROJECT_ID }}Was this page helpful?