Jenkins iOS自动打包流程

背景

在开发中我们经常需要打测试包，然后上传至蒲公英等三方平台，这其中需要经历的操作为：

Git仓库拉取代码
设置项目的打包环境
利用 xcode 进行打包
上传至蒲公英等三方平台

每一次打包，上面的过程必不可少，而且都是手工的，本篇文章我们将采用CD（Continuous Delivery）持续交付和CI（Continuous Integration）持续集成来进行自动化打包一键操作，解放双手，拒绝手动的重复低效率劳动。

本篇文章讲解如何使用 Jenkins + shell脚本以及 Jenkins + fastlane 自动打包发布至蒲公英等三方平台。

CI/CD（持续集成、持续交付/持续部署）

CI/CD 是一种通过在应用开发阶段引入自动化来频繁向客户交付应用的方法。

CI/CD 的核心概念是持续集成、持续交付和持续部署。作为一个面向开发和运营团队的解决方案，CI/CD 主要针对在集成新代码时所引发的问题。

具体而言，CI/CD 可让持续自动化和持续监控贯穿于应用的整个生命周期（从集成和测试阶段，到交付和部署）。这些关联的事务通常被统称为“CI/CD 管道”，由开发和运维团队以敏捷方式协同支持。

CI（Continuous Integration）是指持续集成，它属于开发人员的自动化流程。成功的 CI 意味着应用代码的新更改会定期构建、测试并合并到共享存储库中。该解决方案可以解决在一次开发中有太多应用分支，从而导致相互冲突的问题。
CD（Continuous Delivery/Deployment）是指持续交付或持续部署
- 持续交付通常是指开发人员对应用的更改会自动进行错误测试并上传到存储库（如 GitHub 或容器注册表），然后由运维团队将其部署到实时生产环境中。这旨在解决开发和运维团队之间可见性及沟通较差的问题。因此，持续交付的目的就是确保尽可能减少部署新代码时所需的工作量。
- 持续部署（另一种“CD”）指的是自动将开发人员的更改从存储库发布到生产环境，以供客户使用。它主要为了解决因手动流程降低应用交付速度，从而使运维团队超负荷的问题。持续部署以持续交付的优势为根基，实现了管道后续阶段的自动化。

详细流程

20210304175817690.png

自动化打包流程

graph LR
    1[本地代码] --提交--> 2[远程仓库] --> 3[Jenkins自动打包] --> 4[部署发布到蒲公英/Testflight] --> 5[结果邮件/钉钉/QQ通知]

Jenkins概述

Jenkins 是一款流行的开源持续集成（Continuous Integration）工具，广泛用于项目开发，具有自动化构建、测试和部署等功能。

安装Jenkins环境

使用 Homebrew 软件包管理器安装Jenkins

没有Homebrew的请先安装Homebrew，网上资料很多，这里不再赘述。

安装命令

安装最新的LTS版本：brew install jenkins-lts
安装特定的LTS版本：brew install jenkins-lts@YOUR_VERSION
启动 Jenkins 服务：brew services start jenkins-lts
重新启动 Jenkins 服务：brew services restart jenkins-lts
更新 Jenkins 版本：brew upgrade jenkins-lts

安装步骤

启动 Jenkins 服务后，浏览 http://localhost:8080 ，该页面需要确认是管理员安装，让我们输入密码，根据提示获取管理员密码，点击继续。
选择安装推荐的插件，等待插件安装完毕。
插件安装完成后会自动跳转到配置管理员账户页，配置完成点击保存并完成注册。
浏览器输入 http://localhost:8080 打开Jenkins，登录即可。

Jenkins 配置-iOS

安装相关插件

构建xcode项目需要安装的插件

Git Parameter：分支管理

在Jenkins首页->系统管理->插件管理搜索相关插件进行安装即可。

环境变量配置

选择系统管理 -> 系统配置 -> 全局属性 -> 勾选环境变量选项
键：PATH
值：在终端中输入echo $PATH将输出内容复制填写。

image-20220605203314715.png

新建任务

创建任务

在Jenkins首页->新建任务中输入任务名称，选择构建一个自由风格的软件项目，点击确定。

image-20220604085359715.png

任务相关配置

选择General -> 参数化构建过程 -> Git参数

image-20220604085859262.png

填写名称，选择类型为分支类型，默认origin/master

image-20220604090215644.png

选择源码管理 -> Git，输入仓库地址，添加账号密码。

image-20220604095423461.png

选择构建 -> 增加构建步骤 -> 执行shell

image-20220605190845531.png

添加打包脚本，保存。

 ```
 #!/bin/sh
export LANG=en_US.UTF-8
USERNAME="hugengwei"
# 1.设置配置标识,编译环境(根据需要自行填写 release ｜debug )
configuration="release"

# 工程名(根据项目自行填写)
APP_NAME="TuWanApp"

# TARGET名称（根据项目自行填写）
TARGET_NAME="TuWanApp"

# ipa前缀（根据项目自行填写）
IPA_NAME="点点开黑"

# info.plist路径
#project_infoplist_path="./${TARGET_NAME}/Info.plist"
# 取版本号
#bundleShortVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleShortVersionString" "${project_infoplist_path}")

#bundleVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleVersion" "${project_infoplist_path}")

# 日期
DATE=$(date +%Y%m%d-%H-%M-%S)
# 工程文件路径
ARCHIVE_NAME="${APP_NAME}_${DATE}.xcarchive"
# 存放ipa的文件夹名称（根据自己的喜好自行修改）
IPANAME="${APP_NAME}_${DATE}_IPA"

# 工程根目录#工程源码目录(这里的${WORKSPACE}是jenkins的内置变量表示(jenkins job的路径):/Users/xxx/.jenkins/workspace/TestDemo/)
# ${WORKSPACE}/TestDemo/ 中的TestDemo根据你的项目自行修改
CODE_PATH="${WORKSPACE}"

# 要上传的ipa文件路径 ${username} 需要换成自己的用户名
ROOT_PATH="/Users/${USERNAME}/Desktop/Jenkins"
ARCHIVE_PATH="${ROOT_PATH}/Archive/${ARCHIVE_NAME}"
IPA_PATH="${ROOT_PATH}/Export/${IPANAME}"
echo "ARCHIVE_PATH: ${ARCHIVE_PATH}"
echo "IPA_PATH: ${IPA_PATH}"
echo "IPA_PATH:\n${IPA_PATH}">> export_history.txt

# 导包方式(这里需要根据需要手动配置:AdHoc/AppStore/Enterprise/Development)
EXPORT_METHOD="AdHoc"
# 导包方式配置文件路径(这里需要手动创建对应的XXXExportOptionsPlist.plist文件，并将文件复制到根目录下[我这里在源项目的根目录下又新建了ExportPlist文件夹专门放ExportPlist文件])
if test "$EXPORT_METHOD" = "AdHoc"; then
    EXPORT_METHOD_PLIST_PATH=${CODE_PATH}/ExportOptions/AdHocExportOptions.plist
elif test "$EXPORT_METHOD" = "AppStore"; then
    EXPORT_METHOD_PLIST_PATH=${CODE_PATH}/ExportOptions/AppStoreExportOptios.plist
elif test "$EXPORT_METHOD" = "Enterprise"; then
    EXPORT_METHOD_PLIST_PATH=${CODE_PATH}/ExportOptions/EnterpriseExportOptions.plist
else
    EXPORT_METHOD_PLIST_PATH=${CODE_PATH}/ExportOptions/DevelopmentExportOptions.plist
fi

# 指ipa定输出文件夹,如果有删除后再创建，如果没有就直接创建
if test -d ${IPA_PATH}; then
    rm -rf ${IPA_PATH}
    mkdir -pv ${IPA_PATH}
     echo ${IPA_PATH}
else
     mkdir -pv ${IPA_PATH}
fi

# 进入工程源码根目录
cd "${CODE_PATH}"

# 执行pod
pod install

#mkdir -p build

# 清除工程
echo "++++++++++++++++clean++++++++++++++++"
xcodebuild clean -workspace ${APP_NAME}.xcworkspace -scheme ${APP_NAME} -configuration ${configuration}

# 将app打包成xcarchive格式文件
echo "+++++++++++++++++archive+++++++++++++++++"
xcodebuild archive -workspace ${APP_NAME}.xcworkspace -scheme ${APP_NAME} -configuration ${configuration} -archivePath ${ARCHIVE_PATH}

# 将xcarchive格式文件打包成ipa
echo "+++++++++++++++++ipa+++++++++++++++++"
xcodebuild -exportArchive -archivePath ${ARCHIVE_PATH} -exportPath "${IPA_PATH}" -exportOptionsPlist ${EXPORT_METHOD_PLIST_PATH} -allowProvisioningUpdates

# 删除工程文件
# echo "+++++++++删除工程文件+++++++++"
# rm -rf $ARCHIVE_PATH

# 蒲公英上传结果日志文件路径
PGYERLOG_PATH="${IPA_PATH}/upload_pgyer_log"
# 创建蒲公英上传结果日志文件夹
mkdir -p ${PGYERLOG_PATH}
# 创建蒲公英上传结果日志文
touch "${PGYERLOG_PATH}/log.txt"

# 上传IPA到蒲公英 根据蒲公英官方文档编写
file_path="${IPA_PATH}/${IPA_NAME}.ipa"
echo "正在上传文件"
echo $file_path
curl -F "file=@${file_path}" -F "uKey=蒲公英的userKey" -F "_api_key=蒲公英的apiKey" https://upload.pgyer.com/apiv1/app/upload   
 ```

Fastlane打包

1、简介
Fastlane是用Ruby语言编写的一套自动化工具集和框架，每一个工具实际都对应一个Ruby脚本，用来执行某一个特定的任务，而Fastlane核心框架则允许使用者通过类似配置文件的形式，将不同的工具有机而灵活的结合在一起，从而形成一个个完整的自动化流程。

2、原理

Fastlane命令执行的底层并不是自己实现的，而是调用其他的插件或者工具执行的。
核心一：打包命令，Fastlane中的gym工具只是xcodebuild工具的一个封装。因此安装Fastlane的步骤里有安装IDE的指令集。
核心二：iTC（即iTunesConnect 苹果的账号证书应用管理平台）命令。苹果除了提供图形化可操作的网页之外，还提供相对应的一整套底层 API 给开发者使用，Fastlane的底层操作是封装的这套API。

我们iOS开发者，感觉最繁琐的事就是打包上架了，打包过程不仅繁琐还特别耗费时间。那么有没有工具能将我们解放出来呢？有，答案就是Fastlane。Fastlane是移动端App开发的脚本工具。
使用Fastlane自动打包上传的基本步骤如下：
1、安装Fastlane -> 2、Fastlane初始化 -> 3、配置证书和描述文件 -> 4、一键上传

Fastlane的安装有多种途径，其中之一就是使用sudo gem install fastlane命令安装，其他途径这里不再赘述，也是一行命令的事。
可以用命令fastlane --version来查看是否安装成功
在项目中初始化fastlane 使用命令fastlane init，根据提示一步步进行即可。
初始化成功之后，在项目根目录下会多几个文件，Appfile苹果账号信息、Fastfile填写打包脚本的地方（重点、重点、重点）。
若使用蒲公英上传，需安装蒲公英插件，在终端输入fastlane add_plugin pgyer命令，即可安装蒲公英的 fastlane 插件。

Fastlane打包脚本示例（使用Ruby语言）

default_platform(:iOS)

#蒲公英api_key和user_key
api_key = "your api_key"
user_key = "your user_key"
configuration = "Release"#Debug_Production_Server

platform :iOS do
  desc "打包并上传蒲公英"
  lane :pgybeta do
  #指定项目的scheme名称
  scheme = "TuWanApp"
  #更新描述
  update_desc = "更新描述"
  gym(
    #输出的ipa名称
    output_name:"#{scheme}_#{Time.new.strftime("%Y%m%d%H%M")}",
    # 是否清空以前的编译信息 true：是
    clean:true,
    scheme:scheme,
    # 指定打包方式，Release 或者 Debug
    configuration:"#{configuration}",
    # 指定打包所使用的输出方式，目前支持app-store, package, ad-hoc, enterprise, development
    export_method:"ad-hoc",
    # 指定输出文件夹
    output_directory:"./build/pgy",
    )
  pgyer(api_key: "#{api_key}", user_key: "#{user_key}", update_description: "#{update_desc}")
  end
end

Jenkins + Fastlane配置

Jenkins shell脚本

#!/bin/bash
 
export LANG=en_US.UTF-8
 
export LANGUAGE=en_US.UTF-8
 
export LC_ALL=en_US.UTF-8
 
set -e
 
#输出错误
function echo_error() {
    echo "\033[31m$1\033[0m"
}
 
#输出信息
function echo_info() {
    echo "\033[32m$1\033[0m"
}
 
#打包
function packaging() {
 
    echo_info "====================开始===================="
 
    #参数校验 $#  添加到Shell的参数个数
    if [ $# != "1" ] || ([ $1 != "debug" ] && [ $1 != "release" ] && [ $1 != "appStore" ]); then
       echo_error '请指定打包类型：debug, release, appStore'
       exit 1
    fi
 
    #参数配置
    fastlane_output_path="./build/pgy"
    
    #你的蒲公英账号 API Key
    PGY_API_KEY="your api_key"
 
    #定义一些符变量
    export v_env=$1
    export v_project_name="TuWanMusic"
    export v_build_number="${BUILD_NUMBER}"
    export v_git_branch="${GIT_BRANCH}"
    export v_commit_node="$(git log -n 1 --pretty=format:"%h")"
    export v_download_URL="https://www.pgyer.com/8haT"
    export v_QRCode_URL="https://www.pgyer.com/8haT"
    export v_last_10_logs="$(git log -n 10 --pretty=format:"%h %ci %cn%n%s%n")"
 
    echo_info "====================安装pod依赖===================="
    #安装pod依赖
    #rm -rf './Pods/Local Podspecs'
    #pod update
    pod install
 
    #删除构建输出
    rm -rf "${fastlane_output_path}"
    
    #一个项目里面多个target设置
    target="TuWanMusic"
    if [ $1 == "debug" ]; then
        target="TuWanMusic"
    fi
    #版本号
    export v_app_version=$(echo "$(fastlane run get_version_number xcodeproj:OneAset.xcodeproj target:${target}))" | tr -d '\n' | sed -E 's/.*Result: ([0-9\.]*).*/\1/g')
    
 
    #构建
    echo_info "====================构建===================="
    ipa_name="TuWanMusic"
    
    #fastlane打包
    fastlane ${v_env}
 
    #上传二进制包到蒲公英
    if [ $1 != "appStore" ]; then
        echo_info "====================上传二进制包到蒲公英===================="
        resp=$(curl -F "file=@${fastlane_output_path}/${ipa_name}.ipa" -F "_api_key=${PGY_API_KEY}" -F "buildInstallType=1" https://www.pgyer.com/apiv2/app/upload)
        echo "pgy_resp=${resp}"
 
        #解析数据，生成下载地址
        build_key=$(echo "$resp" | tr "\n" " " | sed -E 's/.*"buildKey" *: *"([^"]*)".*/\1/g')
        v_QRCode_URL=$(echo "$resp" | tr "\n" " " | sed -E 's/.*"buildQRCodeURL" *: *"([^"]*)".*/\1/g' | sed -E 's/\\\//\//g')
        v_download_URL="https://www.pgyer.com/apiv2/app/install?_api_key=${PGY_API_KEY}&buildKey=${build_key}"
    
        v_download_URL="https://www.pgyer.com/${build_key}"
 
        echo_info "二维码地址：${v_QRCode_URL}"
 
        echo_info "app下载地址：${v_download_URL}"
            
    fi
    
}
 
export FASTLANE_XCODEBUILD_SETTINGS_TIMEOUT=120
 
#执行打包
packaging ${BuildType}

构建打包任务

选择已创建的任务

image-20220605201225547.png

选择Build with Parameters -> 分支 -> 开始构建。

image-20220605201319733.png

查看控制台输出。

image-20220605202754537.png

补充说明

找不到/ExportOptions/XXXExportOptions.plist文件

AdHocExportOptions.plist，AppStoreExportOptios.plist，EnterpriseExportOptions.plist，DevelopmentExportOptions.plist文件可通过Xcode -> Product -> Archive打包生成的ExportOptions.plist文件添加相应前缀重命名即可获得。
在Jenkins -> workspace -> 项目根目录下新建名为ExportOptions的文件夹，将相应plist文件拷贝到改文件夹中即可。

image-20220605204922279.png

证书及描述文件

在Xcode中配置完成即可。

大文件拉取git-lfs报错

运行brew install git-lfs即可安装
若不再需要大文件支持，可前往项目根目录 -> .git -> hooks -> 移除post-checkout文件即可。

拉取代码出错

cd到Jenkins -> workspace目录下，手动通过git clone将工程clone到本地，重启Jenkins，再次执行打包任务。

局域网使用IP访问jenkins

使用brew安装jenkins会避免很多其他安装方式产生的用户权限问题，但是会将httpListenAddress默认设置为127.0.0.1，这样我们虽然可以在本地用localhost:8080访问，但是本机和局域网均无法用ip访问。

解决办法为修改两个路径下的plist配置：

～/Library/LaunchAgents/homebrew.mxcl.jenkins.plist
/usr/local/opt/jenkins/homebrew.mxcl.jenkins.plist

第二个路径找不到的话，cmd + shift + G 输入/opt/homebrew/opt/jenkins，找到homebrew.mxcl.jenkins.plist

将上面两个plist中的httpListenAddress后的ip地址，修改为本机IP或者0.0.0.0，修改完成后，重启Jenkins，接下来就可以使用IP访问了。

Jenkins-iOS自动打包流程