Support
Continuous Integration Systems

Integrating Invicti Enterprise with GitHub Actions

This document is for:
Invicti Enterprise On-Demand, Invicti Enterprise On-Premises

GitHub Actions automates tasks in your development lifecycle, running commands based on specified events. You can integrate Invicti Enterprise with GitHub using scripts from our Integration Script Generator. This document explains how to generate and use these scripts for integration.

How to generate and use the Invicti Enterprise GitHub Actions script

IMPORTANT: Ensure you create a .github/workflows directory. For more information, refer to GitHub Docs: Quickstart for GitHub Actions.

  1. Log in to Invicti Enterprise.
  2. From the main menu, select Integrations > New Integration.
  3. From the Continuous Integration Systems section, select GitHub Actions.

  1. In the Integration Script Generator section, select the relevant Scan Settings:
  • Scan Type: Choose from Incremental, Full (With primary profile), or Full (With selected profile).
  • Website: Select a website to be scanned.
  • Scan Profile: Choose a scan profile. This field is not displayed if you select Full (With primary profile) as the Scan Type.

  1. If you select the Fail the build if one of the selected scan severity is detected checkbox, Invicti will fail the build in your GitHub Actions if any of the selected severities are found. Specify the severity level in the Scan Severity dropdown that appears when this checkbox is selected.

  1. From the GitHub Actions Script field, Copy the script. The script updates as soon as you make any changes to the fields above.

  1. Log in to your GitHub account.
  2. Navigate to your GitHub Actions window.
  3. Paste the copied script into the Jobs section of [your-project].yml.
  4. Commit and push it to the Git repository.

Committing the workflow file in your repository triggers the event and runs your workflow. For more details on configuring the workflow, refer to GitHub Docs: Workflow syntax for GitHub Actions. For an example scan workflow script, see Invicti GitHub Actions.