目標(biāo)：在iOS的App中獲取到當(dāng)前包所屬的Git信息。
這里我需要當(dāng)前代碼的提交日期、提交作者亭敢、代碼所屬分支、代碼的節(jié)點(diǎn)SHA图筹。
思路：配置script帅刀，獲取到需要的Git的信息然后存入info.plist中，需要的時(shí)候再?gòu)膇nfo.plist中取出远剩。
Step1
Xcode-Build Phases-New Run Script Phase
為了和項(xiàng)目中的其他腳本區(qū)分開扣溺，建議改個(gè)名字（雙擊Run Script改名字），Run Script改為Git Script瓜晤。
Step2
給對(duì)應(yīng)的Target下的info.plist文件增加以下屬性锥余，用于保存腳本執(zhí)行中設(shè)置的Git信息。
Step3
復(fù)制粘貼如下腳本到Git Script中：
#最后一次提交的SHA
git_sha=$(git rev-parse HEAD)
#當(dāng)前的分支
git_branch=$(git symbolic-ref --short -q HEAD)
#最后一次提交的作者
git_last_commit_user=$(git log -1 --pretty=format:'%an')
#最后一次提交的時(shí)間
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}"
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痢掠、多環(huán)境的項(xiàng)目驱犹，在不同Target下的腳本是一樣的,Xcode會(huì)根據(jù)不同target下對(duì)應(yīng)的info.plist(比如develop環(huán)境,對(duì)應(yīng)info_develop.plist)文件在App的安裝包生成的一個(gè)名為info.plist的文件嘲恍，該文件的路徑為
info_plist="${BUILT_PRODUCTS_DIR}/${EXECUTABLE_FOLDER_PATH}/Info.plist"
不需要根據(jù)不同target下的info.plist文件的路徑位置或者名稱的進(jìn)行重寫。
2雄驹、使用模擬器運(yùn)行的話佃牛，如果把腳本刪除后，刪除App重新run依然能夠得Git信息医舆，需要將模擬器Reset俘侠。打出來(lái)的包不會(huì)受此影響。
3蔬将、直接運(yùn)行GitHub鏈接的項(xiàng)目是無(wú)法獲得Git信息爷速，因?yàn)橄螺d的項(xiàng)目沒(méi)有g(shù)it記錄，自己做些改動(dòng)然后commit到本地再run即可霞怀。
包含子工程的項(xiàng)目請(qǐng)繼續(xù)往下看：
iOS子工程獲取Git信息
如果項(xiàng)目中包含子工程惫东，要獲取子工程的git信息，思路如下：
通過(guò)shell腳本保存git信息毙石，但是把git保存到安裝包同級(jí)目錄下的txt文件中廉沮，然后在主工程的腳本中讀取該txt文件，再保存到info.plist中胁黑。
實(shí)際例子如下：
項(xiàng)目結(jié)構(gòu)圖
項(xiàng)目中中包含2個(gè)子工程ShareLibrary、ShareLibrary州泊；
5個(gè)target丧蘸，分別對(duì)應(yīng)Info.plist、Info_Develop.plist遥皂、Info_Api.plist力喷、Info_Sim.plist、Info_Feature.plist 5個(gè)不同的plist文件演训。
我們的例子只對(duì)一個(gè)target進(jìn)行配置弟孟，只保存Git的SHA信息。
Step1:
給info.plist添加字段
Step2:
子工程ShareLibrary添加Git Script,如下圖：
子工程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,如下圖：
子工程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拼接起來(lái)
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;
}
總結(jié)：
弄明白編譯過(guò)程中的主工程样悟、子工程之間的順序和Xcode環(huán)境變量拂募，就可以通過(guò)配置腳本在App中獲取到我們要的git信息。
Xcode把兩個(gè)子工程編譯完成后打包成.a文件,
本文引用文章和相關(guān)知識(shí)點(diǎn)鏈接如下:
參考思路
Git提交信息
PlistBuddy簡(jiǎn)單使用
Xcode環(huán)境變量
