diff --git a/README.md b/README.md index 9314864..f7890a7 100644 --- a/README.md +++ b/README.md @@ -18,15 +18,20 @@ include: where `` is the latest released tag or `main`. -If you want to leverage the `$SECRET_DETECTION_DISABLED` variable to run the `secret_detection` job conditionally use `include:rules`. Otherwise the job will run when applicable: +If you are converting the configuration to use components and want to leverage the existing variable `$SECRET_DETECTION_DISABLED` you could conditionally include the component using the variable: ```yaml include: - component: gitlab.com/gitlab-components/secret-detection@main rules: - - if: $SECRET_DETECTION_DISABLED != "true" + - if: $SECRET_DETECTION_DISABLED == "true" || $SECRET_DETECTION_DISABLED == "1" + when: never ``` +Otherwise the job will run when applicable. + +This assumes `SECRET_DETECTION_DISABLED` variable is already defined in `.gitlab-ci.yml` with either `'true'` or `'1'` as the value. + ### Inputs | Input | Default value | Description |