git_submodule_version_checker

关于git_submodule_version_checker.sh

git_submodule_version_checker.sh 是一个git submodule的版本检测工具，主要用于帮助主项目在本地检测“其当前依赖的子项目的版本”和“子项目的本地仓库实际指向的版本”是否一致。

检测判断一个子项目的版本是否一致的步骤如下：

1. 获取当前子项目的本地仓库当前指向的commitId：submodules_head_commit_id
2. 获取主项目记录的当前子项目的版本commitId：submodules_associated_commit_id
3. 判断submodules_associated_commit_id是否为空，若为空，说明当前子项目为新增子模块，需要提示开发者在主项目中进行提交；若不为空，则将2个commitId进行比较，若二者一致，则说明当前子项目的版本是一致的

移动端开发工程按照下述教程，接入git_submodule_version_checker到主项目工程后，每次进行编译前，都会自动对依赖的子项目的版本进行检查，若存在版本不一致的子项目，则编译会以失败结束。

iOS主工程接入git_submodule_version_checker

接入步骤如下：

1. 下载git_submodule_version_checker，放置到主工程根目录，如图：

   

2. 用Xcode打开主工程的，选择主工程Target > Build Phase > + ，如图所示新建一个名为[CP] Check Git Submodule Version的Run Script Phase：

   

   • Run Script Phase代码：

     root_dir=$SRCROOT
     sh $root_dir/git_submodule_version_checker/git_submodule_version_checker.sh $root_dir
     if [ $? != 0 ]
     then 
     echo "error: This main repo has bad submodules, please run 'git submodule update --init --recursive' to fix it" >&2
     exit 1
     fi
     echo "SUCCESS"
     

   • 注意和红框一样，反选Show environment variables in build log和Run script only when installing

Android主工程接入git_submodule_version_checker

接入步骤如下：

1. 下载git_submodule_version_checker，放置到主工程根目录，如图：

   

2. 用Android Studio 打开主工程，选择主工程 > app > build.gradle ，如图所示添加名为check_git_submodule_version的task，并为preBuild这个task设置依赖：

   

   ​

   上述添加的完整代码如下：

   task check_git_submodule_version(type: Exec) {
       def root_dir = getRootDir()
       executable "sh"
       args "$root_dir/git_submodule_version_checker/git_submodule_version_checker.sh", "$root_dir"
   
       ignoreExitValue true
   
       doLast {
           logger.lifecycle("check result: $execResult")
   
           if(execResult.exitValue == 0) {
               logger.lifecycle('SUCCESS')
           } else {
               throw new GradleException("This main repo has bad submodules, please run \'git submodule update --init --recursive\' to fix it.")
           }
       }
   
   }
   
   preBuild.dependsOn check_git_submodule_version

Examples

以下是接入了git_submodule_version_checker工具的示例：

• iOS Example
• Android Example

PS：你可以使用这些示例对工具进行测试。