如何使用命令行自动化构建项目

前言

    将 iOS 应用程序构建分发或者部署到 iTunes Connect 涉及各种各样的事情。iOS 开发人员使用 Xcode 构建，测试，归档，导出 ipa 进行分发或者上传到 iTunes Connect 是非常常见的做法。

使用 Xcode 构建

    在通过 Xcode 构建时，往往都是重复的步骤，大致流程如下：

1. 拉取仓库最新的代码；
2. 进行 pod install ；
3. 修改一些配置项或者代码，例如：配置指定的证书，描述文件等等；
4. Clean 工程；
5. 使用 Xcode -> Products -> Archive 归档工程，生成 .xcarchive 文件；
6. 查看 Xcode -> Window -> Organizer 中的 Archives 列表；
7. 选择对应的.xcarchive 文件 Export 进行分发或者上传 Appstore。

如何使用命令行构建项目

    可以看到通过 Xcode 构建、分发和部署是非常耗时的事情，幸运的是，Apple 有命令行工具来完成所有这些工作，其中一个最受欢迎的实用工具是 xcodebuild。关于 xcodebuild 的介绍可以查看。

    当然，每次在终端输入 xcodebuild 命令和直接使用 Xcode 一样繁琐。因此，通常将这些命令保存在 Shell 脚本中，让我们来看看，怎样配置一个 Shell 脚本实现一行命令完成上面的任务。

prepare

1. 配置打包相关的参数

   • 名称：.xcworkspace或者 .xcodeproj的名字、scheme 名称等等。根据自己的情况编写，下面参照示例：

     # .xcworkspace的名字，必填
     workspace_name="xxxxx"
     # 指定项目的scheme名称（也就是工程的target名称），必填
     scheme_name="xxxxx"
     # 指定 configuration  ，一般用Release。
     build_configuration="Release"
     # displayName appVersion buildVersion 等等
     

• 路径：archive 输出文件路径、导出 ipa文件路径、ExportOptions.plist 文件路径。根据自己的情况编写，下面参照示例：

  # 获取当前脚本所在目录
  script_dir="$( cd "$( dirname "$0"  )" && pwd  )"
  # 工程根目录
  project_dir=$script_dir
  # 指定输出导出文件夹路径
  export_path="$project_dir/Build"
  # 指定输出归档文件路径
  export_archive_path="$export_path/$scheme_name.xcarchive"
  # 指定输出ipa文件夹路径
  export_ipa_path="$export_path/"
  # 指定导出ipa包需要用到的plist配置文件的路径
  export_options_plist_path="$project_dir/ExportOptions.plist"
  

• ExportOptions.plist：配置较多的情况，可以用 PlistBuddy 生成。根据自己的情况编写，下面参照示例：

  echo "bundle_identifier = ${bundle_identifier}"
  echo "method = ${method}"
  echo "mobileprovision_name = ${mobileprovision_name}"
  /usr/libexec/PlistBuddy -c  "Add :method String ${method}"  $export_options_plist_path
  /usr/libexec/PlistBuddy -c  "Add :provisioningProfiles:"  $export_options_plist_path
  /usr/libexec/PlistBuddy -c  "Add :provisioningProfiles:${bundle_identifier} String ${mobileprovision_name}"  $export_options_plist_path
  /usr/libexec/PlistBuddy -c  "Add :compileBitcode bool NO" $export_options_plist_path
  

2. 拉取仓库代码，并进行 pod install

   cd ${project_dir}
   git pull 或者在一个新的目录执行 git clone
   pod install --repo-update
   

3. 使用 Plistbuddy、Python 或者 Shell 修改一些配置项或者代码，比如修改 Info.plist 中的版本号

   /usr/libexec/PlistBuddy -c 'Set :$key string "value" ' info.plist
   

构建

4. 使用 xcodebuild clean 清理工程

   xcrun xcodebuild clean -workspace ${workspace_name}.xcworkspace \
                    -scheme ${scheme_name} \
                    -configuration ${build_configuration}
   

5. 使用 xcodebuild archive 归档

   xcrun xcodebuild archive -workspace ${workspace_name}.xcworkspace \
                      -scheme ${scheme_name} \
                      -configuration ${build_configuration} \
                      -archivePath ${export_archive_path}
   

6. 使用 xcodebuild -exportArchive 导出 .ipa 文件

   ExportOptions.plist 文件可以通过脚本生成，也可以提前准备好

   xcrun xcodebuild  -exportArchive \
               -archivePath ${export_archive_path} \
               -exportPath ${export_ipa_path} \
               -exportOptionsPlist ${export_options_plist_path} \
               -allowProvisioningUpdates
   

部署

    可以用输出的 ipa 文件上传至蒲公英、fir.im 、私有存储以及 iTunes Connect 等等

蒲公英

    蒲公英提供上传 App API，需要 user key 、 api key 以及安装密码 password

curl -F "file=@/tmp/example.ipa" -F "uKey=" -F "_api_key=" -F "password=" https://upload.pgyer.com/apiv1/app/upload

Fir.im

    Fir.im 同样提供了发布 App API，需要 API_Token。上传分为两步：

1. 获取上传凭证

   名称	类型	必填	说明
   type	String	是	ios 或者 android（发布新应用时必填）
   bundle_id	String	是	App 的 bundleId（发布新应用时必填）
   api_token	String	是	长度为 32, 用户在 fir 的 api_token

   curl -X "POST" "http://api.bq04.com/apps" \
        -H "Content-Type: application/json" \
        -d "{\"type\":\"ios\", \"bundle_id\":\"xxx.xxx.xx\", \"api_token\":\"xxx\"}"
   

2. 上传文件

   将 ICON 和安装包文件分别上传到上一步操作中获取到的 cert.icon 和 cert.binary 中的 upload_url

   curl   -F "key=xxxxxx"              \
          -F "token=xxxxx"             \
          -F "[email protected]"            \
          -F "x:name=xxxx"             \
          -F "x:version=a.b.c"         \
          -F "x:build=1"               \
          -F "x:release_type=Adhoc"   \  
          -F "x:changelog=first"       \
          https://up.qbox.me
   

iTunes Connect

    苹果提供了 altool 上传 App 的二进制文件，在使用 altool 上传之前，需要提前准备开发者认证信息。

1. 验证 App

   xcrun altool --validate-app -f ${ipa_path} -t ios --apiKey ${api_key} --apiIssuer ${issuer_id} --verbose
   

2. 上传 App

   xcrun altool --upload-app -f ${ipa_path} -t ios --apiKey ${api_key} --apiIssuer ${issuer_id} --verbose