From c1ca675db8f88cf7c04788034192f688a881cdad Mon Sep 17 00:00:00 2001 From: Bertrand Goareguer <bertrand.goareguer@gmail.com> Date: Thu, 20 Feb 2025 09:44:21 +0000 Subject: [PATCH] chore(doc): explain how to extend default rules --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 51725d6..a89feb5 100644 --- a/README.md +++ b/README.md @@ -58,4 +58,7 @@ Here is how this GitLab CI template chooses the Gitleaks rules to use: 1. It first looks for a `.gitleaks.toml` file at the root of your project repository. 2. If not found, it uses the `.toml` file specified with the `$GITLEAKS_RULES` variable. -3. If not specified, [default Gitleaks rules] (https://github.com/zricethezav/gitleaks/blob/master/config/gitleaks.toml) are used. +3. If not specified, [default Gitleaks rules](https://github.com/zricethezav/gitleaks/blob/master/config/gitleaks.toml) are used. + + +Your Gitleaks rule file can extend the default rules by using `[extend]` + `useDefault = true` as explained in the [Gitleaks documentation](https://github.com/gitleaks/gitleaks/blob/master/README.md#configuration) -- GitLab