From ccc6fd5065c4aaa4e63383dce9ca64b7c50380ee Mon Sep 17 00:00:00 2001 From: kai ru <69238381+kairu-ms@users.noreply.github.com> Date: Fri, 6 Dec 2024 12:16:22 +0800 Subject: [PATCH] Improve pre-commit message (#30476) --- .githooks/pre-commit.ps1 | 8 +++++--- .githooks/pre-commit.sh | 11 +++++------ 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.githooks/pre-commit.ps1 b/.githooks/pre-commit.ps1 index 33af0e1eb1f..6c1a159fb86 100644 --- a/.githooks/pre-commit.ps1 +++ b/.githooks/pre-commit.ps1 @@ -17,8 +17,7 @@ if (git rev-parse --verify HEAD 2>$null) { $against = "HEAD" } else { - # Initial commit: diff against an empty tree object - Write-Host "Using empty tree object as the previous commit" + Write-Host "Using an empty tree object as the previous commit" $against = $(git hash-object -t tree /dev/null) } @@ -29,7 +28,10 @@ foreach ($file in $files) { # Check if the file contains secrets $detected = $(azdev scan -f $file | ConvertFrom-Json).secrets_detected if ($detected -eq "True") { - Write-Host "Detected secrets from $file. You can run 'azdev mask' to remove secrets before commit." -ForegroundColor Red + Write-Host "Detected secrets from $file. Please run the following command to mask it:" -ForegroundColor Red + Write-Host "+++++++++++++++++++++++++++++++++++++++++++++++++++++++" -ForegroundColor Red + Write-Host "azdev mask -f $file" -ForegroundColor Red + Write-Host "+++++++++++++++++++++++++++++++++++++++++++++++++++++++" -ForegroundColor Red $hasSecrets = 1 } } diff --git a/.githooks/pre-commit.sh b/.githooks/pre-commit.sh index 6a368450353..4d57e09f371 100644 --- a/.githooks/pre-commit.sh +++ b/.githooks/pre-commit.sh @@ -16,22 +16,21 @@ then printf "Using HEAD as the previous commit\n" against=HEAD else - printf "Using empty tree object as the previous commit\n" + printf "Using an empty tree object as the previous commit\n" against=$(git hash-object -t tree /dev/null) fi has_secrets=0 - -IFS_OLD=${IFS} -IFS=$'\n' for FILE in `git diff --cached --name-only --diff-filter=AM $against` ; do # Check if the file contains secrets detected=$(azdev scan -f "$FILE" | python -c "import sys, json; print(json.load(sys.stdin)['secrets_detected'])") if [ "$detected" = "True" ]; then - printf "\033[0;31mDetected secrets from %s, You can run 'azdev mask' to remove secrets before commit.\033[0m\n" "$FILE" + printf "\033[0;31mDetected secrets from %s, Please run the following command to mask it:\033[0m\n" "$FILE" + printf "\033[0;31m+++++++++++++++++++++++++++++++++++++++++++++++++++++++\033[0m\n" + printf "\033[0;31mazdev mask -f %s\033[0m\n" "$FILE" + printf "\033[0;31m+++++++++++++++++++++++++++++++++++++++++++++++++++++++\033[0m\n" has_secrets=1 fi done -IFS=${IFS_OLD} if [ $has_secrets -eq 1 ]; then printf "\033[0;31mSecret detected. If you want to skip that, run add '--no-verify' in the end of 'git commit' command.\033[0m\n"