DocsGuidesGithub actions

GitHub Actions

A complete workflow that runs Quell on every push and pull request, with PR comments showing your PRS delta.

Quick setup

quell install github-action

Or create .github/workflows/quell.yml manually:

name: Quell

on:
  push:
    branches: [main, master]
  pull_request:

jobs:
  edge-cases:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: pip

      - name: Install Quell
        run: pip install quelltest

      - name: Check edge cases
        run: quell ci src/ --threshold 75 --format json > quell-report.json

      - name: Upload report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: quell-report
          path: quell-report.json

PR comment with PRS delta

Add a comment showing the score change on each PR:

      - name: Comment PRS on PR
        if: github.event_name == 'pull_request'
        uses: actions/github-script@v7
        with:
          script: |
            const report = require('./quell-report.json');
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `**Quell PRS: ${report.score}/100** — ${report.tier}\n\n` +
                    `✓ ${report.written} written · ~ ${report.scaffolded} scaffolded · ✗ ${report.flagged} flagged`
            });

Caching

Cache pip packages to speed up runs:

      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: pip

Environment variables for LLM

If you use LLM fallback, add your key as a GitHub secret:

      - name: Check edge cases
        env:
          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
        run: quell ci src/ --threshold 75