feat: Automate commit & push with Gemini AI

Author: wesleyscholl

git-commit-push-script.sh

@@ -1,13 +1,19 @@
+## Automating Staging, Committing and Pushing to GitHub with Gemini AI 👨🏻‍💻➡️
+## AI commits generated from git diff 
+
+## *** A free Gemini AI API key is required to run this shell script *** - https://www.getgemini.ai/
+## Configuration instructions: https://github.com/wesleyscholl/git-commit-push-script 
+
 #!/bin/bash
 source ~/.bash_profile
 
 # Stage all changes
 git add -A
 
-# Get branch name
+# Get the branch name
 base_branch=$(git rev-parse --abbrev-ref HEAD)
 
-# Extract ticket number from current directory
+# Extract Jira ticket number from current directory 
 ticket=$(echo $base_branch | grep -o -E '([A-Za-z]+-[0-9]{3,}|[A-Za-z]+-[0-9]{3,})')
 
 # Get the git diff
@@ -26,15 +32,15 @@ gemini_request='{
 	}
 }'
 
-# Get commit message from Gemini API
+# Request and parse the commit message from Gemini API
 commit_message=$(curl -s \
   -H 'Content-Type: application/json' \
   -d "$gemini_request" \
   -X POST "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash-latest:generateContent?key=${GEMINI_API_KEY}" \
   | jq -r '.candidates[0].content.parts[0].text'
   )
 
-# If the commit message is empty, try again
+# If the commit message is empty, retry the request
 if [ -z "$commit_message" ]; then
 	commit_message=$(curl -s \
 	  -H 'Content-Type: application/json' \
@@ -47,14 +53,16 @@ fi
 # Clean up commit message formatting - remove #, ```,
 commit_message=$(echo $commit_message | sed 's/#//g' | sed 's/```//g' | sed 's/Commit message title://g' | sed 's/Commit message summary://g')
 
+# Print the commit message
 echo $commit_message
 
+# If the Gemini retry request fails, exit
 if [ -z "$commit_message" ]; then
 	echo "Error: API request for commit message failed. Please try again."
 	exit 1
 fi
 
-# Prepare and execute commit command
+# Prepare and execute commit command, remove -S to commit without signing
 if [ -z "$ticket" ]; then
 	git commit -S -m "$commit_message"
 else
@@ -73,18 +81,21 @@ pull_push_after_failed_push() {
 
 # Check if the branch exists on the remote
 if [ -z "$remote_branch" ]; then
+	# If the branch does not exist on the remote, create it
 	echo "Branch '$base_branch' does not exist on remote. Creating it."
 	# Push the local branch to the remote, setting the upstream branch
 	git push --set-upstream origin $base_branch
 
+	# Check if the push was successful, if previous command is not a failure, 
+  	# execute the function to handle a failed push
 	if [ $? -ne 0 ]; then
 		pull_push_after_failed_push
 	fi
-else
+else # Branch exists on the remote, push changes to the remote branch
 	echo "Branch '$base_branch' exists on remote. Pushing changes."
-	# Push changes to the remote
 	git push
 
+	# Check if the push wasn't successful, execute the function to handle a failed push
 	if [ $? -ne 0 ]; then
 		pull_push_after_failed_push
 	fi