Преглед на файлове

chore: tweak logging and readme for GITLEAKS_CONFIG_TOML feature (#1802)

Richard Gomez преди 10 месеца
родител
ревизия
e273a970a4
променени са 2 файла, в които са добавени 19 реда и са изтрити 19 реда
  1. 17 17
      README.md
  2. 2 2
      cmd/root.go

+ 17 - 17
README.md

@@ -229,23 +229,23 @@ your `.git/hooks/` directory.
 The order of precedence is:
 The order of precedence is:
 
 
 1. `--config/-c` option:
 1. `--config/-c` option:
-  ```bash
-  gitleaks git --config /home/dev/customgitleaks.toml .
-  ```
-1. Environment variable `GITLEAKS_CONFIG` with the file path:
-  ```bash
-  export GITLEAKS_CONFIG="/home/dev/customgitleaks.toml"
-  gitleaks git .
-  ```
-1. Environment variable `GITLEAKS_CONFIG_TOML` with the file content:
-  ```bash
-  export GITLEAKS_CONFIG_TOML=`cat customgitleaks.toml`
-  gitleaks git .
-  ```
-1. A `.gitleaks.toml` file within the target path:
-  ```bash
-  gitleaks git .
-  ```
+      ```bash
+      gitleaks git --config /home/dev/customgitleaks.toml .
+      ```
+2. Environment variable `GITLEAKS_CONFIG` with the file path:
+      ```bash
+      export GITLEAKS_CONFIG="/home/dev/customgitleaks.toml"
+      gitleaks git .
+      ```
+3. Environment variable `GITLEAKS_CONFIG_TOML` with the file content:
+      ```bash
+      export GITLEAKS_CONFIG_TOML=`cat customgitleaks.toml`
+      gitleaks git .
+      ```
+4. A `.gitleaks.toml` file within the target path:
+      ```bash
+      gitleaks git .
+      ```
 
 
 If none of the four options are used, then gitleaks will use the default config.
 If none of the four options are used, then gitleaks will use the default config.
 
 

+ 2 - 2
cmd/root.go

@@ -131,9 +131,9 @@ func initConfig(source string) {
 	} else if os.Getenv("GITLEAKS_CONFIG_TOML") != "" {
 	} else if os.Getenv("GITLEAKS_CONFIG_TOML") != "" {
 		configContent := []byte(os.Getenv("GITLEAKS_CONFIG_TOML"))
 		configContent := []byte(os.Getenv("GITLEAKS_CONFIG_TOML"))
 		if err := viper.ReadConfig(bytes.NewBuffer(configContent)); err != nil {
 		if err := viper.ReadConfig(bytes.NewBuffer(configContent)); err != nil {
-			logging.Fatal().Msgf("unable to load gitleaks config from GITLEAKS_CONFIG_TOML env var content(%s), err: %s", configContent, err)
+			logging.Fatal().Err(err).Str("content", os.Getenv("GITLEAKS_CONFIG_TOML")).Msg("unable to load gitleaks config from GITLEAKS_CONFIG_TOML env var")
 		}
 		}
-		logging.Debug().Msgf("using gitleaks config from GITLEAKS_CONFIG_TOML env var content: %s", configContent)
+		logging.Debug().Str("content", os.Getenv("GITLEAKS_CONFIG_TOML")).Msg("using gitleaks config from GITLEAKS_CONFIG_TOML env var content")
 		return
 		return
 	} else {
 	} else {
 		fileInfo, err := os.Stat(source)
 		fileInfo, err := os.Stat(source)