Skip to content
🔄CI/CD Integration

Integrate Zof with GitHub Actions

Intermediate15 min read·Updated December 2024·Platform EngineersDevelopers

Add Zof reliability testing to your GitHub Actions workflow to catch issues before they reach production.

Prerequisites

Before you begin, make sure you have:

  • A Zof account - Sign up free
  • Access to your code repository (GitHub, GitLab, or Bitbucket)
  • Node.js 18+ or Python 3.9+

What you'll achieve

  • Installed and authenticated the Zof CLI
  • Connected Zof to your project
  • Ran your first reliability test
  • Viewed results in the Zof dashboard

Step 1: Install the Zof CLI

Open your terminal and install the CLI globally:

bash
npm install -g @zof/cli

Verify the installation:

bash
zof --version

Expected result: zof/2.x.x

Step 2: Authenticate with Zof

Connect the CLI to your Zof account:

bash
zof login

This opens your browser to complete authentication. Once authorized, you'll see:

text
✓ Authenticated as your@email.com

Tip

Use a service account token for CI rather than your personal token. You can create one at Settings → API Tokens in the Zof dashboard.

Step 3: Initialize your project

Navigate to your project directory and initialize Zof:

bash
cd your-project
zof init

Zof creates a zof.config.json file with sensible defaults for your project type.

Step 4: Run your first test

Execute a quick validation:

bash
zof run --quick

This runs a subset of agents for fast feedback (full runs take longer but are more comprehensive).

Note

The --quick flag runs only smoke and sanity agents. Use zof run without flags for a comprehensive test.

Verify it works

  1. Open app.zof.ai
  2. Navigate to Results
  3. You should see your first test run with findings categorized by severity

You should see: A results summary showing reliability score, issues found, and test coverage.

Troubleshooting

Was this guide helpful?

01Gouvernance + visibilité des dirigeants

Rapports que les dirigeants, les auditeurs et le conseil d’administration peuvent réellement utiliser.

Zof génère les rapports dont vos révisions de versions, vos ensembles de preuves de conformité et vos lectures de direction ont déjà besoin, à une cadence que vous définissez, avec la trace des données en pièce jointe.

EXÉCUTIF

Résumés hebdomadaires

Libérez la santé dans une seule vue.

PRÊT POUR L'AUDIT

Pack de conformité

  • SOC 2
  • ISO
  • piste de preuves.

CADENCE

Programmé

Généré automatiquement selon votre emploi du temps.

AUDIT-READY/reports
Page de rapports Zof AI avec quatre modèles de cartes, résumé de version hebdomadaire, tendances de couverture, rapport d'évaluation des risques et pack de preuves de conformité, chacun avec des actions de génération et de planification, ainsi que des onglets pour les rapports générés, les vues enregistrées et planifiées.
Rapports · /rapports · quatre modèles d'entreprise · en direct du produit.
  • 01 · TEMPLATES
    • Weekly
    • Coverage
    • Risk

    Schedule or generate on demand

  • 02 · COMPLIANCE EVIDENCE
    • SOC 2
    • ISO
    • audit pack

    Exportable evidence trail

Guides | Zof AI