Skip to main content

Azure DevOps

Basic example​

Here's how you can integrate Escape with Azure DevOps:

trigger:
  branches:
    include:
      - staging

pool:
  vmImage: 'ubuntu-latest'

jobs:
- job: EscapeScan
  displayName: 'Escape Scan'
  dependsOn: deploy # name of your deployment job
  
  variables:
    ESCAPE_APPLICATION_ID: $(EscapeAppId) # Define these in the Azure DevOps Pipeline environment variables or in a variable group.
    ESCAPE_API_KEY: $(EscapeApiKey)

  steps:
  - script: |
      npm install -g @escape.tech/action
      npm show @escape.tech/action version
      escape-action
    displayName: 'Run Escape Action'
    env: 
      ESCAPE_APPLICATION_ID: $(EscapeAppId)
      ESCAPE_API_KEY: $(EscapeApiKey)
    continueOnError: true

Available variables​

ESCAPE_APPLICATION_ID string required​

The id of the application on Escape that will be scanned continuously.
You can find it in your Escape application settings.

ESCAPE_API_KEY string required​

Your API key on the Escape platform.
You can find it in your Escape settings.

TIMEOUT number​

The timeout of the job. If set to 0, the scan will be started, but the job will not wait for it to be finished before terminating.

The triggered scan will run asynchronously on Escape, and your team will be notified once it is done using your desired notifications settings.

CONFIGURATION_OVERRIDE string​

See the configuration override section.

CONFIGURATION_OVERRIDE_PATH string​

See the configuration override section.

COMMIT_HASH string​

See the commit identification section.

INTROSPECTION_FILE number​

See the introspection update section.

Command-line options​

--output <path> string​

The path to the output file that will contain the scan results.