05 CI/CD

GitHub Action integration

Add security scanning to your CI pipeline. SARIF results appear in the GitHub Security tab.

.github/workflows/security.yml
name: Security Scan

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

permissions:
  security-events: write
  contents: read

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Install VEXLIT
        run: npm install -g @vexlit/cli

      - name: Full scan (push to main)
        if: github.event_name == 'push'
        run: vexlit scan . --sarif > results.sarif --fail-on critical

      - name: Diff scan (pull request)
        if: github.event_name == 'pull_request'
        run: vexlit scan --diff --sarif > results.sarif --fail-on warning

      - name: Upload SARIF
        if: always()
        uses: github/codeql-action/upload-sarif@v3
        with:
          sarif_file: results.sarif

Inputs

--fail-oncritical | warning | info
--diffGit changed files only
--sarifSARIF output
--formattable | json | sarif

Outputs

totalTotal vulnerabilities
criticalCritical count
sarif-fileSARIF output path