Skip to main content

Gitlab CI

Basic example

Escape:
stage: post-deploy
needs:
- deploy # name of your deployment job
variables: # you can find those secrets directly in your Escape Application Settings
- ESCAPE_APPLICATION_ID: $ESCAPE_APPLICATION_ID
- ESCAPE_API_KEY: $ESCAPE_API_KEY
image: node:alpine
before_script:
- npm install -g @escape.tech/action
- npm show @escape.tech/action version
script:
- escape-action
allow_failure: true
only:
refs:
- staging

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.