diff --git a/README.md b/README.md index 5e31d95..77b9717 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ keyword. ```yaml include: - - component: gitlab.com/gitlab-components/sastg@ + - component: gitlab.com/gitlab-components/sast@ ``` where `` is the latest released tag or `main`. @@ -29,3 +29,21 @@ where `` is the latest released tag or `main`. | `excluded_paths` | `"spec, test, tests, tmp"` | Comma separated list of paths to exclude | | `search_max_depth` | `4` | Defines how many directory levels the search for programming languages should span | | `run_kubesec_sast` | `"false"` | Set it to `"true"` to run `kubesec-sast` job | + +### Variables + +| Variable | Default value | Description | +| -------- | ------------- | ----------- | +| `SAST_DISABLED` | not set | Set to `true` to avoid running any SAST jobs | + +### ToDos + +- Move the use of `SAST_DISABLED` to the `include:` + +```yaml +include: + - component: gitlab.com/gitlab-components/sast@main + inputs: { ... } + rules: + - if: $SAST_DISABLED != "true" +```