iOS 底層原理38:自動化打包(二)Jenkins + GitLab 實現自動打包

iOS 底層原理 文章匯總

前提

一般大型的公司都有部署好的Jenkins環境,所以這里不在贅述Jenkins的搭建過程,對于Jenkins不了解的童鞋可以自行google下。

Jenkins作為可擴展的自動化服務器,可用作簡單的持續集成(CI,Continuous Integration)服務器,或是持續交付(CD,Continuous Deployment)中心。其特點如下:

  • 即時性。Jenkins是一個基于Java運行的程序,可立即運行,包含Windows、MacOSX、Linux等。

  • 配置簡單。可以通過網頁輕松配置

  • 插件豐富。目前有1000多插件

  • 擴展性強,Jenkins可以通過插件架構進行擴展,從而為Jenkins提供了無限可能

  • 分布式部署,可以在多態機器上分配工作,幫助開發者快速構建、測試等

所以,對于開發者來說,Jenkins可以簡單的通過配置git源和xcode插件配置打包項,就可以實現服務器自動打包了。

Jenkins實現自動打包的方式主要有兩種:

  • 無Jenkins服務器: 搭建Jenkins服務器 + 配置環境 + 自動打包配置
  • 有Jenkins服務器: 創建Mac從節點 + 配置環境 + 自動打包配置

備注:以下配置的前提都是基于已部署好的Jenkins服務器進行的。

Jenkins環境配置

全局的配置主要是配置打包所需的證書簽名。使用管理員賬戶登錄Jenkins,安裝以下插件

上傳證書

  • 1、將發布證書+簽名相關文件夾拷貝至桌面,并將login.keychain-db 改為 login.keychain

  • 2、manage jenkins -> Keychains and Provisioning Profiles Management -> 選擇login文件并upload

    上傳keychain

  • 3、填寫正確的code signing,如下所示,紅框中的內容就是code signing的值


    codeSigning

最終效果如下


證書最終效果

上傳簽名

  • 1、填寫Provisioning Profiles文件的具體路徑,格式為:/Users/管理員用戶名/Library/MobileDevice/Provisioning Profiles

  • 2、拷貝具體的簽名,并upload,最終效果如下所示


    簽名最終效果

Mac從節點創建

【前提】:Jenkins的master是Linux系統,首先嘗試在Linux打包,但是結果不盡人意,主要有以下問題

  • 1、pod 命令找不到,使用npm,但是npm命令不會生成.xcworkspace文件
  • 2、xcodebuild命令找不到,有文檔提示使用Facebook提供的xcbuild,但是仍然報錯

【結論】

  • iOS在Linux打包比較復雜,需要找到pod、xcode命令相關的替代命令,以及其他未發現的坑。
  • 所以為了更好的將自動化應用起來,采用了jenkins配置MaxOSX從節點,用于解決pod、xcode命令找不到的問題。

創建Mac從節點的步驟如下:

  • 1、開啟要綁定的MacOSX系統的電腦的遠程登錄:系統偏好設置?共享?勾選?遠程登錄。用于獲取遠程登錄的用戶名 + IP

    配置遠程登錄

  • 在MacOSX的user文件中創建Jenkins文件夾:/User/Shared/Jenkins,需要開放讀寫權限

    配置Jenkins文件夾

  • 3、管理員賬戶登錄jenkins,創建從節點:Manage Jenkins ? Manage Node and Clouds ? New Node

    創建從節點-01

    創建從節點-02

  • 4、配置節點:需要提前安裝配置Slave節點的插件:SSH Slaves plugin

    配置從節點

其中Credentials的配置如下所示:add -> Jenkins -> 選擇Username with password

配置Credentials

  • 5、到此為止,節點創建完成了,會自動連接:MacOSX -> log查看連接日志,以便及時排查問題


    從節點成功效果

創建iOS項目

  • 1、新建項目:New Item,填寫項目名稱,選擇項目風格


    新建item

通用配置

  • 2、【特別提醒!!!】在項目時,需要配置運行的節點:項目 -> configure -> General
    選擇運行節點

源碼配置

  • 3、配置源碼 - Source Code Management


    配置源碼

說明:

  • git源碼鏈接:最好是SSH的鏈接,不要https的
  • 配置源碼的分支,一般是master
  • credential:Add - Jenkins - SSH Username with private key,粘貼SSH


    配置git的Credential

Item環境配置

  • 4、配置編譯環境 - Build Environment
    配置keychain,選擇對應的code signing(注:創建項目后,需要點擊Apply,可能才會顯示配置好的證書簽名)


    配置code signing

自動打包腳本配置
構建打包shell腳本,主要分為兩部分

  • git clone源碼 + pod install
# 使用方法
# 1、替換自己項目:項目文件夾名(同git名一致)、git地址
# 2、


# 使用cocoapods需要加入這句
#!/bin/bash -l 
export LANG=en_US.UTF-8
export LANGUAGE=en_US.UTF-8
export LC_ALL=en_US.UTF-8


# 項目的參數 build:表示是否進行編譯
if [ $build == false ]; then
  exit
fi

if [ -d "xxxxx" ]; then
    echo '----------已有項目----------'
else
    echo '----------下載項目----------'
    # 需要替換成自己項目的地址
    git clone git@xxxxx.git  
fi

# 進入項目文件夾
cd xxxxx
echo 'pod install路徑--'${workdir}
# 切換分支
git checkout dev
# 拉取最新代碼 git pull origin 【遠程分支名】:【本地分支名】
git pull origin dev:dev


# 更新pod
# 跳轉至podfile所在目錄
cd xxxxx
cur_dir=$(pwd)
echo '-----------install路徑--'${cur_dir}
echo '---------------------------------------'
pod install
  • 打ipa包 + 上傳AppStore
#項目名
PROJECT_NAME='xxxxx'

#App名稱
APP_NAME='xxxxx'

#scheme名稱
SCHEME_NAME='xxxxx'

#打包模式
CONFIGURATION=release

#  下面兩個參數只是在手動指定Pofile文件的時候用到,如果使用Xcode自動管理Profile,直接留空就好
# (跟method對應的)mobileprovision文件名,需要先雙擊安裝.mobileprovision文件.手動管理Profile時必填
mobileprovision_name=""

# 項目的bundleID,手動管理Profile時必填
bundle_identifier=""

echo "--------------------腳本配置參數檢查--------------------"
echo "PROJECT_NAME = ${PROJECT_NAME}"
echo "APP_NAME = ${APP_NAME}"
echo "SCHEME_NAME = ${SCHEME_NAME}"
echo "CONFIGURATION = ${CONFIGURATION}"
echo "mobileprovision_name = ${mobileprovision_name}"
echo "bundle_identifier = ${bundle_identifier}"


# 指定輸出導出文件夾路徑,version是項目配置的參數,每次可手動輸入
export_path=${cur_dir}/build-${version}
#archive文件存放路徑
ARCHIVE_PATH=$export_path/$SCHEME_NAME.xcarchive

#ipa文件存放路徑
IPA_PATH=${export_path}/

#plist 文件路徑:導出ipa所需的文件
EXPORT_OPTIONS_PLIST_PATH=${cur_dir}/ExportOptions.plist


echo "--------------------腳本固定路徑檢查--------------------"
echo "export_path = ${export_path}"
echo "ARCHIVE_PATH = ${ARCHIVE_PATH}"
echo "IPA_PATH = ${IPA_PATH}"
echo "EXPORT_OPTIONS_PLIST_PATH = ${EXPORT_OPTIONS_PLIST_PATH}"


# 先刪除export_path文件
if [ -f "$export_path" ] ; then
    echo "${export_path}文件存在,進行刪除"
    rm -f $export_path
fi



#清理工程
echo "--------------------正在清理工程--------------------"
xcodebuild clean -workspace ${PROJECT_NAME}.xcworkspace -scheme ${SCHEME_NAME}

echo "--------------------清理完成 ?? ?? ??--------------------"

security unlock-keychain -p "1109221208l" ~/Library/Keychains/login.keychain

#生成archive文件
echo "--------------------正在生成 .xcarchive 文件--------------------"
xcodebuild \
-workspace ${PROJECT_NAME}.xcworkspace \
-scheme ${SCHEME_NAME} \
-configuration ${CONFIGURATION} \
-archivePath ${ARCHIVE_PATH} \
archive


#  檢查是否構建成功
#  xcarchive 實際是一個文件夾不是一個文件所以使用 -d 判斷
if [ -d "$ARCHIVE_PATH" ] ; then
    echo " 項目構建成功 ?? ?? ??  "
else
    echo " 項目構建失敗 ?? ?? ??  "
    exit 1
fi
echo "------------------------------------------------------"


#打ipa包
echo "--------------------正在導出 .ipa 文件--------------------"
echo '正在 導出 .ipa 文件'
xcodebuild  -exportArchive \
            -archivePath ${ARCHIVE_PATH} \
            -exportPath ${IPA_PATH} \
            -exportOptionsPlist ${EXPORT_OPTIONS_PLIST_PATH} \
            -allowProvisioningUpdates
       
# 檢查文件是否存在
if [ -f "$IPA_PATH/$SCHEME_NAME.ipa" ] ; then
    echo " 導出 ${SCHEME_NAME}.ipa 包成功 ??  ??  ??   "
    echo " ipa包路徑:$export_path "
else
    echo " 導出 ${SCHEME_NAME}.ipa 包失敗 ?? ?? ??     "
    exit 1
fi

# 輸出打包總用時
echo "使用Jenkins打包總用時: ${SECONDS}s "
echo "------------------------------------------------------"


# 將包上傳AppStore  
cd build-${version}
ipa_path="$SCHEME_NAME.ipa"
# 上傳AppStore的密鑰ID、Issuer ID
api_key="FFX6T2CD4W"
issuer_id="69a6de70-bd1a-47e3-e053-5b8c7c11a4d1"

echo "--------------------AppStore上傳固定參數檢查--------------------"
echo "ipa_path = ${ipa_path}"
echo "api_key = ${api_key}"
echo "issuer_id = ${issuer_id}"

# 項目的參數 upload:表示是否上傳AppStore
if [ $upload == false ]; then
  echo "-------未選擇上傳AppStore--------"
else

    echo "------------------------------------------------------"
    echo "-------準備上傳AppStore--------"
    
    # 驗證
    validate="xcrun altool --validate-app -f ${ipa_path} -t ios --apiKey ${api_key} --apiIssuer ${issuer_id} --verbose"
    echo "running validate cmd" $validate
    uvalidateApp="$($validate)"
    if [ -z "$uvalidateApp" ]; then
        echo " 校驗IPA失敗?? ?? ??   "
        echo "------------------------------------------------------"
    else
        echo " 校驗IPA成功??  ??  ??  "
        echo "------------------------------------------------------"
        
        # 上傳
        upload="xcrun altool --upload-app -f ${ipa_path} -t ios --apiKey ${api_key} --apiIssuer ${issuer_id} --verbose"
        echo "running upload cmd" $upload
        uploadApp="$($upload)"
        echo uploadApp
        if [ -z "$uploadApp" ]; then
            echo " 傳IPA失敗?? ?? ??   "
            echo "------------------------------------------------------"
            # 發送上傳失敗郵件通知
            mail -s "ipa上傳AppStore失敗啦 ?? ?? ?? ,請聯系管理員" ${notiEmail}
        else
            echo "上傳IPA成功??  ??  ?? "
            echo "------------------------------------------------------"
            # 發送上傳成功郵件通知
            mail -s "ipa上傳AppStore成功啦 ??  ??  ??" ${notiEmail}
        fi

    fi
fi
    

exit 0

備注:mac電腦需要配置上傳相關的密鑰,參考文章:使用xcrun altool上傳ipa

使用

  • 登錄Jenkins,選擇對應的打包項目


    選擇item
  • 構建一個新的版本


    構建新版本
  • 自動打包過程中可進入具體的版本,查看終端日志


    打包log

遇到的問題

在執行pod 命令時,提示pod command not found

  • 解決方法】在shell腳本最前面加上 #!/bin/bash -l
#!/bin/bash -l
export LANG=en_US.UTF-8

pod install 私有三方庫報錯

code signing報錯

  • 報錯:Command CodeSign failed with a nonzero exit code
  • 原因:是 Jenkins,ssh 方式到 slave 機上,默認是沒有賬戶的,但是訪問鑰匙串要求必須有用戶身份,所以添加一步輸入密碼解鎖鑰匙串,可以給 Jenkins 一個用戶身份。
  • 【解決辦法】: build 步驟前添加一步解鎖鑰匙串
security unlock-keychain -p "login pwd" ~/Library/Keychains/login.keychain

所以,綜上所述,Jenkins自動打包流程如下


Jenkins自動打包流程圖示

參考文章

iOS-最新Jenkins自動化打包配置完整教程
GitLab CI/CD,iOS項目管控實戰應用
部署在 linux 服務器上的 Jenkins 到底能否實現
從零開始-Linux服務器上用jenkins搭建Java/Android/Ios持續集成環境
Jenkins配置節點(解決Linux上iOS打包)
遠程Jenkins新增Mac電腦節點

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容