Recipes

CI / GitHub Actions

Sample workflow using qa-audit.yml and secrets.

Store QA_AUDIT_API_KEY as a repository secret. Commit qa-audit.yml with your staging or production URL.

.github/workflows/qa-audit.yml
name: QA Audit
on:
  pull_request:
  workflow_dispatch:

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm install -g @qa-audit/qa-audit-cli
      - name: Run project audit
        env:
          QA_AUDIT_API_KEY: ${{ secrets.QA_AUDIT_API_KEY }}
          QA_AUDIT_API_URL: https://qa-audit.com
        run: qa-audit run --json --out qa-report.json
      - uses: actions/upload-artifact@v4
        with:
          name: qa-audit-report
          path: qa-report.json
one-liner scan in CI
qa-audit scan map "${{ vars.SITE_URL }}" --tier essential --pages 10 --json --out map.json