前言

随着项目的迭代和规范化, 我们可能不满足一直重复的手动编译 打包 发布 测试, 这时就会去寻找一些自动化持续集成的工具, 比如 Jenkins FastLane 等, 但是对于 iOS 开发者来说, 这些非我们熟悉的语言和技术来搭建的工具, 总觉得有那么一点不友好, 那么有没有我们能非常容易上手的持续集成方案呢?

有, 答案就是 Xcode Server, 这个工具在 Xcode 9 之前是要 购买 128 元的 macOS Server 才能使用的, 在 Xcode 9 开始就被集成到了 Xcode 开发工具中来了, 我们可以在自己电脑 或一台专用的 Mac 电脑上, 安装 Xcode, 并启用这个功能, 一个持续集成的服务器就搭建好了.

Xcode Server 有哪些功能呢？

  • 按 时间周期 或者 代码提交 触发持续集成
  • 在构建前或后执行一些脚本, 或发送邮件
  • 直接在 Xcode 中查看集成历史, 错误警告测试等数量, 下载归档或ipa文件, 手动集成等.
  • 也提供了网页版, 上一条的功能基本都有
  • 手机可以打开网页, 选择某次构建直接安装对应App

本文的环境和要求

  • macOS High Sierra 10.13.5
  • Xcode 9.4 (9.0及以上即可)
  • 项目需要使用 Git 进行版本控制, 并且有一个可访问的远程仓库

启用 Xcode Server

  1. 点击 Xcode 菜单: Xcode -> Xcode Server...

    WX20180613-151316@2x.png

  2. 打开开关, 输入账户密码, 选择一个用户作为 Xcode Server 用户 (苹果建议不要用管理员用户, 我这里在我自己电脑上演示, 就直接使用了)

    WX20180613-145319@2x.png

  3. 点击 Continue 等待完成, 即成功启用. 可以在状态栏上看到一个锤子🔨图标

创建 Bot (机器人/自动程序)

  1. 打开项目, 先把准备持续集成的项目 Schemes 设置为共享 Shared 状态

    WX20180613-151537@2x.png
    WX20180613-151816@2x.png

  2. 创建新 Bot: 点击 Xcode 菜单: Product -> Create Bot..., 输入 Bot 名称, 选择刚才创建好的 Xcode Server, 如果没有就先添加 Add New Server...

    WX20180613-152049@2x.png

  3. 登录你项目的 Git 仓库, Xcode Server 会到这个仓库拉取最新代码持续集成. (所以你没有提交到远程仓库的修改不会参与打包之类的), 登录成功后, 如果有多分支就选择你需要集成的分支, 然后点下一步

    WX20180613-153123@2x.png

  4. 构建配置:

    • 选择你的 Scheme
    • Analyze: 如果需要静态分析勾上
    • Test: 如果需要测试勾上
    • Archive: 归档, 会生成 .xcarchive 包
      • Export: 导出 .ipa, 可以选择不导出 (Do Not Export)、导出安装文件 (Installable Product)、和使用自定义导出选项 (Use Custom Export Options Plist). 实测只能使用自定义导出选项, 不然没法正常导出, 或导出的包不能正常安装. 使用自定义选项的话需要选择一个 Plist 文件, 先在 Xcode 手动导出一个 Ad Hoc 包, 生成的文件夹里面有个 ExportOptions.plist, 选择这个就是了.
    • Configuration: 选择配置 (一般默认就可以了, 也可以手动选择 Debug 或 Release)
      WX20180613-153743@2x.png

  5. 集成计划:

    • Integrate:
      • Periodically: 定期. 可以设置每小时、每天、每周 的某个时间点自动集成
      • On Commit: 在提交时. 每次提交代码并推到远程仓库的时候, 会自动集成, 一般需要结合第3步, 在非开发分支上使用, 不然就太频繁了.
      • Manually: 手动集成. 需要打包时手动在 Xcode 或者 Xcode Server 自带的网页上点击 Integrate 集成
    • 在 Xcode 升级之后自动集成, 可以第一时间知道升级带来的问题
    • Clean: 集成前先清理项目. 可以选择始终、每天一次、每周一次、从不
      WX20180613-162605@2x.png

  6. 证书签名:

    • Options: 勾选开发团队账号, 如果项目是 Xcode 自动管理证书和描述文件的, 这边全部勾上就行了.
      WX20180613-165518@2x.png

    • Certificates & Profiles: 如果是手动管理的证书和描述文件, 选择需要的点击 Add to Server 添加到 Xcode Server 中.
      WX20180613-170452@2x.png

  7. 添加构建参数 和 环境变量

    可以添加执行构建命令时的参数, 和自定义环境变量. 没有就直接跳过了.

    WX20180613-170804@2x.png

  8. 配置触发器:

    • Pre-Integration Script: 集成前的脚本, 可以添加一些在拉取到最新代码后, 构建前需要执行的脚本, 比如安装 CocoaPods 第三方SDK:
      WX20180613-172855@2x.png

        #!/bin/sh

  # 设置执行环境的语言编码
  export LANG=en_US.UTF-8
  export LANGUAGE=en_US.UTF-8
  export LC_ALL=en_US.UTF-8

  # 进入到项目目录
  cd $XCS_PRIMARY_REPO_DIR

  # 运行 pod install
  /usr/local/bin/pod install

    • Post-Integration Script: 集成后的脚本, 可以添加一些构建后需要执行的脚本, 可以设置执行条件. 比如构建成功后 (项目有警告之类的也要勾上, 不然就不算成功脚本不会执行), 上传 ipa 包到蒲公英:
      WX20180613-173738@2x.png

        #!/bin/sh

  # 输出产品(.ipa)路径
  echo $XCS_PRODUCT

  # 上传到蒲公英
  curl -F "file=@$XCS_PRODUCT" \
  -F "uKey=你的用户Key" \
  -F "_api_key=你的apiKey" \
  https://www.pgyer.com/apiv1/app/upload

    • 还可以配置 邮件通知 和 定期邮件报表, 这里不演示了.

  9. 创建完成

    点击 Create 之后, Bot 自动化就创建完成了. 可以在Xcode中看到 Bot 在进行首次构建. 如果没问题, 过一会儿就可以看到本次集成的明细, 有错误、警告、分析、测试的数量; 还有构建的结果, 可以直接保存 .xcarchive 和 .ipa 文件. 不出意外的话蒲公英上也有了刚刚上传的包. 如果有问题可以查看 Logs 日志, 右上角有 Integrate 和 Edit Bot... 按钮, 可以点击再次集成构建, 和编辑修改当前 Bot 自动化的配置

    WX20180613-175835@2x.png
    WX20180613-182900@2x.png

  10. Xcode Server 自带的网页平台

    我们在 Xcode 中可以查看和保存集成的结果, 那么没有安装 Xcode 的测试人员怎么办呢? Xcode 很贴心的提供了一个网页的平台, 上面可以查看集成历史, 下载归档或者ipa包文件, 在Xcode打开本次集成, 直接在网页上开始一次新的集成构建等.

    在浏览器输入 https://电脑名.local/xcode 即可打开, 当然你本机用 https://127.0.0.1/xcode 或者 https://你的ip/xcode 也行. 但是推荐前者, 因为 Xcode Server 是对 电脑名.local 这个域名做的 SSL 加密, HTTPS 证书上就是这个域名.

    WX20180613-185449@2x.png

  11. 手机上直接安装 ipa 包

    Xcode Server 提供了一个内置的网页平台, 这个网页也可以直接用手机浏览器打开, 查看构建历史之类的. 最重要的是可以直接在网页上点击安装 app, 这样我们的测试包其实就可以不用上传到蒲公英之类的第三方分发平台了.

    手机系统浏览器打开 https://电脑名.local/xcode, (注意, 要安装 app 的话就不能使用 ip 之类的了, 因为iOS网页安装 App 要求 HTTPS, 而我们的证书是对这个生成的本地域名进行签名的.) 选择某次集成打开后, 上面有两个按钮:

    • PROFILE: 点击会提示安装描述文件 (如果域名跟证书不匹配会提示错误), 点击允许, 选择iPhone, 点击安装, 完成后, 打开手机 设置->通用->关于本机->证书信任设置->勾选信任 Xcode Server 根证书.
      IMG_5604的副本.png

    • INSTALL: 信任了HTTPS证书后, 以后点击就可以直接安装App了
      IMG_5608的副本.png