目标：在iOS的App中获取到当前包所属的Git信息。
这里我需要当前代码的提交日期、提交作者、代码所属分支、代码的节点SHA。
思路：配置script，获取到需要的Git的信息然后存入info.plist中，需要的时候再从info.plist中取出。
Step1
Xcode-Build Phases-New Run Script Phase
添加Script.png
为了和项目中的其他脚本区分开，建议改个名字（双击Run Script改名字），Run Script改为Git Script。
重命名.png
Step2
给对应的Target下的info.plist文件增加以下属性，用于保存脚本执行中设置的Git信息。
添加字段.png
Step3
复制粘贴如下脚本到Git Script中：
#最后一次提交的SHA
git_sha=$(git rev-parse HEAD)
#当前的分支
git_branch=$(git symbolic-ref --short -q HEAD)
#最后一次提交的作者
git_last_commit_user=$(git log -1 --pretty=format:'%an')
#最后一次提交的时间
git_last_commit_date=$(git log -1 --format='%cd')
#获取App安装包下的info.plist文件路径
info_plist="${BUILT_PRODUCTS_DIR}/${EXECUTABLE_FOLDER_PATH}/Info.plist"
#利用PlistBuddy改变info.plist的值
//usr/libexec/PlistBuddy -c "Set :'GitCommitSHA' '${git_sha}'" "${info_plist}"
/usr/libexec/PlistBuddy -c "Set :'GitCommitBranch' '${git_branch}'" "${info_plist}"
/usr/libexec/PlistBuddy -c "Set :'GitCommitUser' ${git_last_commit_user}" "${info_plist}"
/usr/libexec/PlistBuddy -c "Set :'GitCommitDate' '${git_last_commit_date}'" "${info_plist}"
Git Script.png
Step4
获取Git信息
- (NSDictionary *)p_gitInfoDict {
NSDictionary *infoDict = [[NSBundle mainBundle] infoDictionary];
NSString *gitSHA = [infoDict objectForKey:@"GitCommitSHA"];
NSString *gitBranch = [infoDict objectForKey:@"GitCommitBranch"];
NSString *gitCommitUser = [infoDict objectForKey:@"GitCommitUser"];
NSString *gitCommitDate = [infoDict objectForKey:@"GitCommitDate"];
gitSHA = [@"GitSHA:" stringByAppendingString:(gitSHA == nil ? @"" : gitSHA)];
gitBranch = [@"GitBranch:" stringByAppendingString:(gitBranch == nil ? @"" : gitBranch)];
gitCommitUser = [@"GitCommitUser:" stringByAppendingString:(gitCommitUser == nil ? @"" : gitCommitUser)];
gitCommitDate = [@"GitCommitDate:" stringByAppendingString:(gitCommitDate == nil ? @"" : gitCommitDate)];
NSDictionary *gitDict = @{@"gitSHA" : gitSHA,
@"gitBranch" : gitBranch,
@"gitCommitUser" : gitCommitUser,
@"gitCommitDate" : gitCommitDate};
return gitDict;
}
注意:
1、多环境的项目，在不同Target下的脚本是一样的,Xcode会根据不同target下对应的info.plist(比如develop环境,对应info_develop.plist)文件在App的安装包生成的一个名为info.plist的文件，该文件的路径为
info_plist="${BUILT_PRODUCTS_DIR}/${EXECUTABLE_FOLDER_PATH}/Info.plist"
不需要根据不同target下的info.plist文件的路径位置或者名称的进行重写。
2、使用模拟器运行的话，如果把脚本删除后，删除App重新run依然能够得Git信息，需要将模拟器Reset。打出来的包不会受此影响。
3、直接运行GitHub链接的项目是无法获得Git信息，因为下载的项目没有git记录，自己做些改动然后commit到本地再run即可。
包含子工程的项目请继续往下看：
iOS子工程获取Git信息
如果项目中包含子工程，要获取子工程的git信息，思路如下：
通过shell脚本保存git信息，但是把git保存到安装包同级目录下的txt文件中，然后在主工程的脚本中读取该txt文件，再保存到info.plist中。
实际例子如下：
项目结构图
项目中中包含2个子工程ShareLibrary、ShareLibrary；
5个target，分别对应Info.plist、Info_Develop.plist、Info_Api.plist、Info_Sim.plist、Info_Feature.plist 5个不同的plist文件。
我们的例子只对一个target进行配置，只保存Git的SHA信息。
项目结构.png
Step1:
给info.plist添加字段
添加字段.png
Step2:
子工程ShareLibrary添加Git Script,如下图：
添加Script.png
子工程ShareLibrary的Git Script：
#最后一次提交的SHA
git_sha=$(git rev-parse HEAD)
git_filePath="${BUILT_PRODUCTS_DIR}/GitShareLibrary.txt"
touch "$git_filePath"
echo "$git_sha" > "$git_filePath"
Step3:
子工程IMLibrary添加Git Script,如下图：
添加Script.png
子工程IMLibrary的Git Script：
#最后一次提交的SHA
git_sha=$(git rev-parse HEAD)
git_filePath="${BUILT_PRODUCTS_DIR}/GitIMLibrary.txt"
touch "$git_filePath"
echo "$git_sha" > "$git_filePath"
Step4:
主工程Git Script如下：
#子工程git信息txt文件路径
git_filePath_shareLibrary="${BUILT_PRODUCTS_DIR}/GitShareLibrary.txt"
git_filePath_iMLibrary="${BUILT_PRODUCTS_DIR}/GitIMLibrary.txt"
#主工程和子工程的SHA信息
git_sha_uschoolTeacher=$(git rev-parse HEAD)
git_sha_shareLibrary=`cat "$git_filePath_shareLibrary"`
git_sha_imLibrary=`cat "$git_filePath_iMLibrary"`
#把主工程和子工程的SHA拼接起来
git_sha="UschoolTeacher:$git_sha_uschoolTeacher\n \
IMLibrary:$git_sha_imLibrary\n \
ShareLibrary:$git_sha_shareLibrary"
#获取App安装包下的info.plist文件路径
info_plist="${BUILT_PRODUCTS_DIR}/${EXECUTABLE_FOLDER_PATH}/Info.plist"
#利用PlistBuddy改变info.plist的值
/usr/libexec/PlistBuddy -c "Set :'GitCommitSHA' '${git_sha}'" "${info_plist}"
#删除生成的git信息txt文件
rm "$git_filePath_shareLibrary"
rm "$git_filePath_iMLibrary"
最后获取信息：
- (NSDictionary *)p_gitInfoDict {
NSDictionary *infoDict = [[NSBundle mainBundle] infoDictionary];
NSString *gitSHA = [infoDict objectForKey:@"GitCommitSHA"];
STDLog(@"gitSHA:%@",gitSHA);
gitSHA = [@"GitSHA:" stringByAppendingString:(gitSHA == nil ? @"" : gitSHA)];
NSDictionary *gitDict = @{@"gitSHA" : gitSHA};
return gitDict;
}
总结：
弄明白编译过程中的主工程、子工程之间的顺序和Xcode环境变量，就可以通过配置脚本在App中获取到我们要的git信息。
Xcode把两个子工程编译完成后打包成.a文件,
本文引用文章和相关知识点链接如下:
参考思路
Git提交信息
PlistBuddy简单使用
Xcode环境变量
网友评论