GitHub Actions

Overview

The secuprobe/scan-action GitHub Action integrates SecuProbe into your CI/CD pipeline. It automatically triggers a security scan on every deployment, and can fail the pipeline if vulnerabilities above a specified severity level are detected.

Prerequisites

1. A SecuProbe account on the Pro or Enterprise plan.
2. An API key with scans:create and scans:read scopes — create one in Settings → API.
3. Add the key as a GitHub repository secret named SECUPROBE_API_KEY.

Basic usage

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

on:
  push:
    branches: [main]
  pull_request:

jobs:
  secuprobe:
    runs-on: ubuntu-latest
    steps:
      - name: Run SecuProbe Scan
        uses: secuprobe/scan-action@v1
        with:
          api_key: ${{ secrets.SECUPROBE_API_KEY }}
          url: https://your-app.com
          fail_on_severity: critical

Inputs

Outputs

Advanced usage

- name: Run SecuProbe Scan
  id: scan
  uses: secuprobe/scan-action@v1
  with:
    api_key: ${{ secrets.SECUPROBE_API_KEY }}
    url: ${{ vars.STAGING_URL }}
    fail_on_severity: high
    timeout: '900'

- name: Print scan result
  run: |
    echo "SecuScore: ${{ steps.scan.outputs.secu_score }}"
    echo "Report: ${{ steps.scan.outputs.report_url }}"

GitHub Job Summary

The action automatically writes a rich summary to the GitHub Actions job summary page, including the SecuScore, vulnerability counts by severity, and a link to the full report.