Skip to content

Commit

Permalink
Merge pull request #6 from Escape-Technologies/fix/documentation
Browse files Browse the repository at this point in the history
fix: update options documentation
  • Loading branch information
LMaxence authored Oct 28, 2024
2 parents ada7128 + af67c4d commit c01ed72
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ You can find theses values in your Escape application settings.
- `configuration_override_path`: Loads `configuration_override` from a file. [See the docs on configuration overrides](https://escape.tech/docs/ci-cd/techniques/configuration-override)
- `introspection_file`: The relative path to a JSON file containing an introspection response for updating the application's introspection on Escape. [See the docs on introspection update](https://docs.escape.tech/ci-cd/introspection-update)
- `schema_file`: The relative path to a GraphQL schema file for updating the application's introspection on Escape. [See the docs on introspection update](https://docs.escape.tech/ci-cd/introspection-update)
- `schema_url`: The url to a GraphQL schema file for updating the application's introspection on Escape. [See the docs on introspection update](https://docs.escape.tech/ci-cd/introspection-update)
- `fail_on_severities`: A csv-delimited list of severities to fail on, can be HIGH, MEDIUM, LOW, INFO. [See the docs from the cli](https://www.npmjs.com/package/@escape.tech/action)
- `fail_on_compliance`: A JSON string to define exact controls in an array (or all of them with *), per compliance framework supported. [See the docs from the cli](https://www.npmjs.com/package/@escape.tech/action)

## Usage example

Expand Down
2 changes: 2 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,10 @@ runs:
CONFIGURATION_OVERRIDE: ${{ inputs.configuration_override }}
CONFIGURATION_OVERRIDE_PATH: ${{ inputs.configuration_override_path }}
SCHEMA_FILE: ${{ inputs.schema_file }}
SCHEMA_URL: ${{ inputs.schema_url }}
INTROSPECTION_FILE: ${{ inputs.introspection_file }}
FAIL_ON_SEVERITIES: ${{ inputs.fail_on_severities }}
FAIL_ON_COMPLIANCE: ${{ inputs.fail_on_compliance }}

branding:
icon: "check"
Expand Down

0 comments on commit c01ed72

Please sign in to comment.