GitHub Action.

Run AppVet security, performance, accessibility, and SEO scans on every pull request. The action posts results as a PR comment with scores, grades, and report links.

Quick start

name: AppVet Scan
on: [pull_request]

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: appvet/scan-action@v1
        with:
          url: ${{ env.PREVIEW_URL }}
          api-key: ${{ secrets.APPVET_API_KEY }}

Inputs

Outputs

Using outputs

- uses: appvet/scan-action@v1
  id: scan
  with:
    url: ${{ env.PREVIEW_URL }}
    api-key: ${{ secrets.APPVET_API_KEY }}

- name: Check results
  run: |
    echo "Lowest score: ${{ steps.scan.outputs.lowest-score }}"
    echo "Passed: ${{ steps.scan.outputs.passed }}"

PR comment format

The action posts a summary comment on the pull request. If an AppVet comment already exists, it updates in place (no spam).

The comment includes the lowest score, threshold pass/fail status, and links to the full reports on appvet.dev.

Setup

1. Get an API key at appvet.dev/account#api-keys.
2. Add it as a repository secret: Settings → Secrets and variables → Actions → name it APPVET_API_KEY.
3. Add the workflow file to .github/workflows/appvet.yml.

Examples

Scan on every PR

on: [pull_request]
jobs:
  appvet:
    runs-on: ubuntu-latest
    steps:
      - uses: appvet/scan-action@v1
        with:
          url: https://staging.example.com
          api-key: ${{ secrets.APPVET_API_KEY }}
          threshold: 80

Scan after Vercel preview deploy

on:
  deployment_status:
jobs:
  appvet:
    if: github.event.deployment_status.state == 'success'
    runs-on: ubuntu-latest
    steps:
      - uses: appvet/scan-action@v1
        with:
          url: ${{ github.event.deployment_status.target_url }}
          api-key: ${{ secrets.APPVET_API_KEY }}
          types: security,accessibility
          threshold: 70

Security only

- uses: appvet/scan-action@v1
  with:
    url: ${{ env.STAGING_URL }}
    api-key: ${{ secrets.APPVET_API_KEY }}
    types: security
    threshold: 90

Exit codes

Next steps

• Webhooks — get notified when scans complete.
• Score Badges — embed live score badges in your README.
• CLI — run scans from your terminal or other CI/CD systems.