Developer Docs

CI/CD Integration

Automate your compliance reviews. Catch rejection triggers in every Pull Request before they reach the App Store.

GitHub Actions

.github/workflows/audit.yml

name: App Store Audit
on:
  pull_request:
    branches: [main]
  push:
    branches: [main, develop]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Appraysal Audit
        uses: appraysal/audit-action@v2
        with:
          api-key: ${{ secrets.APPRAYSAL_KEY }}
          # Fail the build if any BLOCKING severity issues are found
          fail-on: 'BLOCKING' 
          # Or fail if precision score drops below 98%
          precision-threshold: 98
          # Optional: Specify standards to check against
          compliance-standard: "['SOC2', 'GDPR']"

Configuration Options

api-keyREQUIRED

string

Your Appraysal API key. Store this in GitHub Secrets.

fail-on

'BLOCKING' | 'WARNING'Default: 'BLOCKING'

The severity level that will cause the CI pipeline to fail.

precision-threshold

number (0-100)Default: 95

Fail the build if detailed precision score drops below this value.

project-path

stringDefault: './'

Path to the root of your iOS or Android project.