Skip to content

Commit c01ed72

Browse files
authored
Merge pull request #6 from Escape-Technologies/fix/documentation
fix: update options documentation
2 parents ada7128 + af67c4d commit c01ed72

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ You can find theses values in your Escape application settings.
2828
- `configuration_override_path`: Loads `configuration_override` from a file. [See the docs on configuration overrides](https://escape.tech/docs/ci-cd/techniques/configuration-override)
2929
- `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)
3030
- `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)
31+
- `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)
3132
- `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)
33+
- `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)
3234

3335
## Usage example
3436

action.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ runs:
3838
CONFIGURATION_OVERRIDE: ${{ inputs.configuration_override }}
3939
CONFIGURATION_OVERRIDE_PATH: ${{ inputs.configuration_override_path }}
4040
SCHEMA_FILE: ${{ inputs.schema_file }}
41+
SCHEMA_URL: ${{ inputs.schema_url }}
4142
INTROSPECTION_FILE: ${{ inputs.introspection_file }}
4243
FAIL_ON_SEVERITIES: ${{ inputs.fail_on_severities }}
44+
FAIL_ON_COMPLIANCE: ${{ inputs.fail_on_compliance }}
4345

4446
branding:
4547
icon: "check"

0 commit comments

Comments
 (0)