From c0cc714dce5ecc5f31f2056492b12c48bd85eb90 Mon Sep 17 00:00:00 2001
From: Fabio Pitino <fpitino@gitlab.com>
Date: Wed, 3 May 2023 11:36:07 +0100
Subject: [PATCH] Add todo for SAST_DISABLED variable

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

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@<VERSION>
+  - component: gitlab.com/gitlab-components/sast@<VERSION>
 ```
 
 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 |
 | `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"
+```