From 029603980be76b67accf290bc4c68a1cf60f8b3f Mon Sep 17 00:00:00 2001
From: Haowei Cai <haoweic@google.com>
Date: Tue, 26 Oct 2021 14:06:25 -0700
Subject: [PATCH] Add comments about what git add . does

---
 scripts/release.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/scripts/release.sh b/scripts/release.sh
index 017a5c000..a5e4dc6f3 100755
--- a/scripts/release.sh
+++ b/scripts/release.sh
@@ -158,10 +158,10 @@ if [[ $CLIENT_VERSION != *"snapshot"* ]]; then
         master_release_notes=$(sed -n "/$section/,/###/{/###/!p}" $output | sed -n "{/^$/!p}" | sed ':a;N;$!ba;s/\n/\\n/g')
         util::changelog::write_changelog v$CLIENT_VERSION "$section" "$master_release_notes"
       done
-      git add .
+      git add .  # Allows us to check if there are any staged release note changes
       if ! git diff-index --quiet --cached HEAD; then
         util::changelog::update_release_api_version $CLIENT_VERSION $CLIENT_VERSION $new_k8s_api_version
-        git add .
+        git add .  # Include the API version update before we commit
         git commit -m "update changelog with release notes from master branch"
       fi
     fi