Skip to content

CI CD Integration

Supratim Dam edited this page Mar 15, 2026 · 1 revision

CI/CD Integration

GitHub Actions

Add GrowthLint to your CI pipeline to catch growth regressions on every PR.

Basic Setup

Create .github/workflows/growthlint.yml:

name: GrowthLint
on: [pull_request]
jobs:
  growthlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - run: pip install -e .
      - run: growthlint check-pr . --min-score 60

With Report Upload

name: GrowthLint
on:
  pull_request:
    branches: [main]
  push:
    branches: [main]
jobs:
  growthlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Install GrowthLint
        run: pip install -e .
      - name: Run tests
        run: python -m pytest tests/ -q
      - name: Run GrowthLint scan
        run: growthlint scan . --format json --output growthlint-report.json
      - name: Upload report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: growthlint-report
          path: growthlint-report.json

The check-pr Command

growthlint check-pr <directory> --min-score <threshold>
Flag Default Description
--min-score 50 Minimum acceptable growth health score

Exit codes:

  • 0 — Score meets threshold
  • 1 — Score below threshold or critical violations found

What Gets Checked

When you run check-pr on a repo directory, GrowthLint:

  1. Scans all HTML/JSX/TSX/PHP/Liquid template files
  2. Detects the platform from project structure
  3. Evaluates all applicable rules
  4. Calculates the growth health score
  5. Fails the build if score < threshold or critical issues exist

Setting the Right Threshold

Threshold Use Case
80+ Mature product with high conversion standards
60-79 Active development, catching major regressions
40-59 Early stage, preventing critical mistakes
< 40 Just getting started, blocking only the worst issues

Start low and increase the threshold as you fix existing issues.

Clone this wiki locally