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

概述:

在一个大型项目下,我们通常通过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'
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容