git-functions

# git-functions: A collection of bash functions to streamline Git operations.
# Source this file in your shell (e.g., source git-functions) to make these commands available.

# ------------------------------------------------------------------------------
# git-resync-clean
# ------------------------------------------------------------------------------
# Resets the local repository's master branch to match the remote origin/master
# and removes all untracked files and directories.
# WARNING: This will discard all local changes and untracked files on master.
#
# Usage: git-resync-clean
#
function git-resync-clean() {
	git fetch origin && git reset --hard origin/master && git clean -f -d
}

# ------------------------------------------------------------------------------
# git-commit-push-branch
# ------------------------------------------------------------------------------
# Commits all tracked modifications (-a) with the provided commit message and
# pushes the commit to the specified remote branch.
#
# Arguments:
#   $1 - Commit message (must be enclosed in double quotes)
#   $2 - Remote branch name to push to
#
# Usage: git-commit-push-branch "My commit message" main
#
function git-commit-push-branch() {
	if [ $# -ne 2 ]
	then
		echo "Correct Syntax: git-commit-push-branch <commit message in double quotes> <branch name>."
	else
	        git commit -a -m "$1"
        	git push -u origin "$2"
	fi
}

# ------------------------------------------------------------------------------
# git-add-commit-push-branch
# ------------------------------------------------------------------------------
# Stages all files (including untracked ones), commits them with the provided
# message, and pushes to the specified branch.
#
# Arguments:
#   $1 - Commit message (must be enclosed in double quotes)
#   $2 - Remote branch name to push to
#
# Usage: git-add-commit-push-branch "Add new feature" feature-branch
#
function git-add-commit-push-branch() {
        git add --all
        git-commit-push-branch "$1" "$2"
}

# ------------------------------------------------------------------------------
# git-scommit-push-branch
# ------------------------------------------------------------------------------
# Commits all tracked modifications (-a) with a GPG signature (-S), using the
# provided commit message, and pushes to the specified remote branch.
#
# Arguments:
#   $1 - Commit message (must be enclosed in double quotes)
#   $2 - Remote branch name to push to
#
# Usage: git-scommit-push-branch "Signed commit message" main
#
function git-scommit-push-branch() {
	if [ $# -ne 2 ]
	then
		echo "Correct Syntax: git-scommit-push-branch <commit message in double quotes> <branch name>."
	else
	        git commit -S -a -m "$1"
        	git push -u origin "$2"
	fi
}

# ------------------------------------------------------------------------------
# git-add-scommit-push-branch
# ------------------------------------------------------------------------------
# Stages all files, creates a GPG-signed commit (-S) with the provided message,
# and pushes to the specified branch.
#
# Arguments:
#   $1 - Commit message (must be enclosed in double quotes)
#   $2 - Remote branch name to push to
#
# Usage: git-add-scommit-push-branch "Signed add & commit" feature-branch
#
function git-add-scommit-push-branch() {
        git add --all
        git-scommit-push-branch "$1" "$2"
}

# ------------------------------------------------------------------------------
# git-rename-branch
# ------------------------------------------------------------------------------
# Renames an existing local branch and updates the remote branch on origin.
# It deletes the old branch name from origin and pushes the new branch name,
# setting up upstream tracking.
#
# Arguments:
#   $1 - Current branch name
#   $2 - New branch name
#
# Usage: git-rename-branch old-name new-name
#
function git-rename-branch() {
        git branch -m "$1" "$2"                 # Rename branch locally    
        git push origin :"$1"                 # Delete the old branch    
        git push --set-upstream origin "$2"   # Push the new branch and set local branch to track the new remote
}

# ------------------------------------------------------------------------------
# git-revert-and-sync-master
# ------------------------------------------------------------------------------
# Fetches the latest updates from origin, hard-resets the current branch to match
# origin/master, and cleans any untracked files/directories.
# Note: This has the same behavior as git-resync-clean.
# WARNING: This will discard all local changes.
#
# Usage: git-revert-and-sync-master
#
function git-revert-and-sync-master() {
	git fetch origin && git reset --hard origin/master && git clean -f -d
}

# ------------------------------------------------------------------------------
# git-revert-and-sync-branch
# ------------------------------------------------------------------------------
# Fetches the latest updates from origin, hard-resets the current branch to match
# origin/<branch_name>, and cleans any untracked files/directories.
# WARNING: This will discard all local changes.
#
# Arguments:
#   $1 - Remote branch name to sync and reset to
#
# Usage: git-revert-and-sync-branch feature-branch
#
function git-revert-and-sync-branch() {
	git fetch origin && git reset --hard origin/"$1" && git clean -f -d
}

# ------------------------------------------------------------------------------
# git-merge-to-master
# ------------------------------------------------------------------------------
# Merges the specified branch into the local master branch, pushes the updated
# master to the remote origin, and deletes the local merged branch.
#
# WARNING: This function sleeps between steps (15s before push, 10s before delete)
# to allow the user to review or cancel the action (via Ctrl+C).
#
# Arguments:
#   $1 - The local branch name to merge into master
#
# Usage: git-merge-to-master feature-branch
#
function git-merge-to-master() {
        git checkout master
        git merge "$1"
        echo "Waiting 15s to confirm the git push"
        sleep 15
        git push -u origin master
        echo "Waiting 10s to confirm the git branch delete"
        sleep 10
        git branch -d "$1"
}

# ------------------------------------------------------------------------------
# git-config
# ------------------------------------------------------------------------------
# Configures the global Git identity (name and email) for the user Sriram S.
#
# Usage: git-config
#
function git-config() {
	git config --global user.name "Sriram S"
	git config --global user.email sriram@cloudbuilder.in
}