Add todo for SAST_DISABLED variable

This commit is contained in:
Fabio Pitino 2023-05-03 11:36:07 +01:00
parent fdefb524c5
commit c0cc714dce

View file

@ -12,7 +12,7 @@ keyword.
```yaml ```yaml
include: include:
- component: gitlab.com/gitlab-components/sastg@<VERSION> - component: gitlab.com/gitlab-components/sast@<VERSION>
``` ```
where `<VERSION>` is the latest released tag or `main`. where `<VERSION>` is the latest released tag or `main`.
@ -29,3 +29,21 @@ where `<VERSION>` is the latest released tag or `main`.
| `excluded_paths` | `"spec, test, tests, tmp"` | Comma separated list of paths to exclude | | `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 | | `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 | | `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"
```