iOS获取Git信息

目标:在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;
}

GitHub链接请戳我

注意:

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环境变量

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

推荐阅读更多精彩内容

  • 用到的组件 1、通过CocoaPods安装 2、第三方类库安装 3、第三方服务 友盟社会化分享组件 友盟用户反馈 ...
    SunnyLeong阅读 14,601评论 1 180
  • 点上一支香烟 把自己关在漆黑的小屋里 虫不鸣 狗不吠 夜色纯纯 星空澄净 香烟漫过窗外 心绪是夜的梦 一个人的...
    金珠玛咪阅读 162评论 1 0
  • 心里的哪种恐惧感又来了,让人绝望的是在那恐惧的深处有那么一丝丝的期待! 整个人已经处在崩溃的边缘,从最先的失望到愤...
    国王_fcf8阅读 226评论 0 0