GitHub Action
Gate pull requests on an audit of the specs and plans they touch.
A drop-in GitHub Action audits changed spec/plan markdown, posts a check run with inline annotations, and fails the check when the gate is blocking.
Audits only the spec/plan files a PR changes.
Check run + inline annotations + optional sticky PR comment.
Preserves spend caps, rate limits, and audit logging.
Best for: Teams who want spec quality enforced automatically on every PR.
Get started
Follow these steps to get up and running.
Create a repo secret
Store your agent key as the encrypted secret CVAI_API_KEY (repo or org settings).
Add the workflow
Copy this file to .github/workflows/eqa-gate.yml in the repo you want to gate.
name: EQA Task-Plan Gate
on:
pull_request:
paths:
- "docs/specs/**/*.md"
- "docs/plans/**/*.md"
permissions:
contents: read
checks: write
pull-requests: write
jobs:
eqa-gate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- id: changed
uses: tj-actions/changed-files@v45
with:
files: |
docs/specs/**/*.md
docs/plans/**/*.md
- if: steps.changed.outputs.any_changed == 'true'
uses: ./.github/actions/eqa-gate
with:
api-key: ${{ secrets.CVAI_API_KEY }}
files: ${{ steps.changed.outputs.all_changed_files }}
# base-url: https://communityvision.ai
# pr-comment: "true"Tune the paths
Adjust the paths filters and files globs to match where your specs and plans live.
Read the results
Under the PR's Checks tab: overall pass/fail, inline annotations on the diff, and an optional sticky comment.
Helpful resources
Other surfaces
CVAI meets you everywhere you work. Explore the other integrations.
Audit specs and plans in a single command, right from your terminal.
One key for everything: agent apps, the REST API v1, and the native MCP server.
Audit the spec open in your editor and see findings as inline squiggles.
Mention @CVAI in any channel to audit a document, right inside Slack.
Audit any page with one click, or let AI browsers call CVAI tools right on the page.
A bundle of design tokens, assets, and specs to build the mobile app with zero design drift.
Get results via signed webhooks, and embed your reports into any page.
GitHub Action — frequently asked questions
How do I gate pull requests on a CVAI spec audit?
Store your agent key as the encrypted repo secret CVAI_API_KEY, then add the EQA gate workflow under .github/workflows/. It audits only the spec and plan markdown a PR changes, posts a check run with inline annotations, and fails the check when the gate is blocking.
Does the CVAI GitHub Action audit every file on every PR?
No. It runs only on the spec and plan files a PR changes, using path filters and file globs you tune to match where your specs and plans live — preserving spend caps, rate limits, and audit logging.