Escape.tech / Action

Run Escape directly in GitHub Actions!

Using this action will allow you to start a security scan for a REST, GraphQL, or Frontend application on the Escape platform.

We recommend providing these values as encrypted secrets.

Setup

This action requires an application ID and an API key to be provided.

You can find these values in your Escape application settings.

Required Arguments

• application_id: The ID of the application on Escape that will be scanned continuously
• api_key: Your API key on the Escape platform

Optional Arguments

• watch: Wait for scan completion
• configuration_override: A JSON override of the scan configuration
• schema: The schema local path or publicly accessible URL. If provided, it will update the schema for the application

Usage Example

---
name: Escape

on:
  push:
    branches:
      - main

jobs:
  Escape:
    runs-on: ubuntu-latest
    steps:
      - name: Escape Scan
        uses: Escape-Technologies/action@v0
        with:
          application_id: ${{ secrets.ESCAPE_APPLICATION_ID }}
          api_key: ${{ secrets.ESCAPE_API_KEY }}
          watch: "true" # to wait for scan completion