Bash Shell自定义助手函数git-submodule-foreach:遍历对每个git子模块仓库执行自定义的函数或命令序列

Bash Shell自定义助手函数git-submodule-foreach:遍历对每个子模块仓库执行自定义的函数或命令序列...

概述:

在一个大型项目下,我们通常通过Git Submodule(子模块)机制引入了其他代码仓库,很多时候我们需要对这些子模块仓库执行一系列操作(包括推送和拉取更新、查看代码变更,替换源文件字符串等等),虽然git原生有自带的 submodule foreach命令可以遍历对子模块仓库执行命令,但自带的这个功能只能执行实际存在的命令(即执行的命令必须是真实存在的可执行文件),无法直接运行终端自定义的函数或命令别名(alias),有一种方法可以曲线救国,实现对子模块仓库调用shell函数的功能,具体方法如下:

git submodule foreach bash -l -c "myfunction"     # myfunction为用户自定义在~/.bash_profile中的函数
git submodule foreach bash -l -c "ll"             # ll为ls的别名引用,实际不存在ll这个命令

但以上方法会fork出额外的子进程,造成额外的性能开销,影响效率,故编写此辅助函数git-submodule-foreach,将其注入到~/.bash_profile或~/.bashrc文件中即可随时随地轻松调用(原理:查看.gitmodules注册了哪些子模块,自动pushd到子模块目录,在当前会话环境下执行自定义函数命令或alias后再退回原工作目录[popd],不再额外fork bash子进程...);

git-submodule-foreach函数代码:

git-submodule-foreach() {
	#自动搜索并进入子模块目录执行自定义的函数或Alias别名,作用类似于Git原生命令 git submodule foreach ...;
	#(场景说明:因 git submodule foreach xxxx 仅支持调用真实存在的命令,无法调用函数或Alias,故写此辅助函数);
	# eg:git-submodule-foreach gtoday
	#     git-submodule-foreach git-log-today
	#     git-submodule-foreach git-plog-today
	#     git-submodule-foreach git-lines-today
	#     git-submodule-foreach git-show-yesterday -s --pretty="%cN\<%cE\>\ %cd\ %s"
	#     git-submodule-foreach 'git-show-yesterday -s --pretty="%cN<%cE> %cd %s"'   #用单引号包含完整的命令行则可以省去转义过程
	#     git-submodule-foreach 'git-log-yesterday|wc -l'    #支持子命令中使用管道符(需用单引号包裹命令行....)
	# Git使用的环境变量请参看:https://git-scm.com/book/zh/v2/Git-%E5%86%85%E9%83%A8%E5%8E%9F%E7%90%86-%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F
	#----------------------------------------------------
	([[ "$*" == "-h" || "$*" == "--help" ]]) && {
			print_color 40 "git-submodule-foreach:\n\t自动从.gitmodules中读取注册的子模块,并自动进入子模块执行自定义的(命令/函数/Alias指令)!"
			echo -e "Usage:"
			echo -e "\tgit-submodule-foreach"
			return
	}
	
	if [ ! -d "./.git" ];then
		print_color 40 "没有发现版本库目录.git,请在GIT仓库根目录运行此命令!"
		return
	elif [ ! -e "./.gitmodules" ];then
		print_color 40 "当前仓库不包含子模块(请检查是否存在.gitmodules文件),程序退出后续操作..."
		return
	fi

	local subModules=$(cat .gitmodules|dos2unix -q|awk -F '=' 'BEGIN{IGNORECARE=1}\
		/\[submodule .*\]/{\
				getline;if(match($0,/^[ \t]*path[ \t]*=/)){gsub(" ","",$2);print $2;}\
		}')
	
	local subModulesPath=($(echo "$subModules"|tr '\n' ' '))
	
	[ -z "$*" ] && set -- "pwd"  #没有指定任何附加参数则打印当前工作目录的绝对路径(pwd)
		
	for subPath in ${subModulesPath[@]};
	do
		[ -d "$subPath" ] && {
				pushd "$subPath" &>/dev/null
				echo "$subPath:"
				#pwd
				eval "$@"  #<---常规模式传递参数注意特殊字符需要转义(如重定向符号<、>等...);你可以用单引号包裹完整的命令行以避免转义的麻烦
				local subRetCode=$?
				echo -e "——————————————————————————————————————————————————————————————————————————————————————————————"
				popd &>/dev/null
				[ $subRetCode -ne 0 ] && break  #子命令返回失败值则退出函数,不再循环向后执行...(测试命令:git-submodule-foreach git-show-yesterday -s --pretty="%cN<%cE> %cd %s" 或  git-submodule-foreach test 1 -eq 2)
				command :  #为了避免输出错误到下一个语句块
			} || {
				print_color 9 "子模块路径:$subPath 不存在,自动跳过!"
			}
	done
	[ $subRetCode -ne 0 ] && print_color 40 "警告:因子模块调用的命令以非零状态退出,未对所有模块执行命令!"
}

使用例子:

1、对子仓库执行简单命令:

git-submodule-foreach git log --oneline -5

2、对子仓库执行自定义函数或alias别名:

git-submodule-foreach print_color $(date +'%F %T')
git-submodule-foreach ll

3、子仓库执行命令时使用管道符:

#注意用单引号包括完整的子命令,否则子命令中的特殊字符需要转义
git-submodule-foreach 'git log --oneline -5|wc -l'
git-submodule-foreach 'git log --oneline -5|tee ./gitlog.log'

4、对子模块仓库一次执行多条命令:

#同上,使用单引号包裹子命令,多条命令用分号或 && 连接即可
#
#  区别:使用分号时,无论上一条命令执行成功与否,都执行下一条命令
#        使用 && 时,只有上一条命令执行成功才会执行下一条命令
git-submodule-foreach 'pwd;git log --oneline -5|wc -l'
git-submodule-foreach 'll && echo 123'
git-submodule-foreach 'lla && echo 123'
posted @ 2022-12-22 17:04  晴云孤魂  阅读(190)  评论(0编辑  收藏  举报