Merge pull request #123 from spaze/patch-1

Document `GITLEAKS_VERSION` env var
gitleaks · Oct 5, 2023 · 4df6500 · 4df6500
2 parents d3511a7 + dc199d1
commit 4df6500
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -56,6 +56,7 @@ jobs:
 - `GITLEAKS_CONFIG` (optional): Path to a [gitleaks configuration file](https://github.com/zricethezav/gitleaks#configuration).
 - `GITLEAKS_ENABLE_UPLOAD_ARTIFACT` (optional): Boolean value that turns on or off uploading a sarif artifact when gitleaks detects secrets. Defaults to `true`.
 - `GITLEAKS_ENABLE_SUMMARY` (optional): Boolean value to enable or disable gitleaks job summary. Defaults to `true`.
+- `GITLEAKS_VERSION` (optional): A particular Gitleaks version to use (e.g. `8.15.3`, no `v` prefix) or use `latest` to always use the newest available version. Defaults to a hard-coded version number.
 ---
 
 ## Questions