使用 Flutter 进行持续交付

遵循 Flutter 的持续交付最佳实践，确保您的应用程序能够频繁地交付给测试人员并在测试人员那里进行验证，而无需使用手动工作流。

有多种持续集成 (CI) 和持续交付 (CD) 选项可用于帮助自动交付您的应用程序。

• Codemagic
• Bitrise
• Appcircle

您可以将 fastlane 与以下工具一起使用

• GitHub Actions
  • 示例：Flutter 项目中的 Github Action
• Cirrus
• Travis
• GitLab
• CircleCI
  • 使用 Fastlane 构建和部署 Flutter 应用程序

本指南介绍如何设置 fastlane，然后将其与您现有的测试和持续集成 (CI) 工作流集成。有关更多信息，请参阅“将 fastlane 集成到现有工作流中”。

fastlane 是一个开源工具套件，用于自动化应用程序的发布和部署。

建议您在迁移到基于云的系统之前，先在本地测试构建和部署过程。您也可以选择从本地机器执行持续交付。

1. 安装 fastlane gem install fastlane 或 brew install fastlane。访问 fastlane 文档 获取更多信息。
2. 创建一个名为 FLUTTER_ROOT 的环境变量，并将其设置为 Flutter SDK 的根目录。（这是为 iOS 部署脚本所需的。）
3. 创建您的 Flutter 项目，并在准备好后，确保您的项目可以通过以下方式构建
   • flutter build appbundle；以及
   • flutter build ipa。
4. 为每个平台初始化 fastlane 项目。
   • 在您的 [project]/android 目录中，运行 fastlane init。
   • 在您的 [project]/ios 目录中，运行 fastlane init。
5. 编辑 Appfile 以确保它们包含应用程序的足够元数据。
   • 检查 [project]/android/fastlane/Appfile 中的 package_name 是否与 AndroidManifest.xml 中的包名称匹配。
   • 检查 [project]/ios/fastlane/Appfile 中的 app_identifier 是否也与 Info.plist 的 bundle identifier 匹配。使用您的相应帐户信息填写 apple_id、itc_team_id、team_id。
6. 设置您在商店中的本地登录凭据。
   • 按照 Supply 设置步骤 并确保 fastlane supply init 成功地从您的 Play 商店控制台同步数据。将 .json 文件视为您的密码，不要将其检入任何公共源代码控制存储库中。
   • 您的 iTunes Connect 用户名已在 Appfile 的 apple_id 字段中。使用您的 iTunes Connect 密码设置 FASTLANE_PASSWORD shell 环境变量。否则，在上传到 iTunes/TestFlight 时将提示您输入。
7. 设置代码签名。
   • 按照 Android 应用程序签名步骤。
   • 在 iOS 上，当您准备好使用 TestFlight 或 App Store 进行测试和部署时，请使用分发证书而不是开发证书创建和签名。
     • 在您的 Apple Developer Account 控制台 中创建并下载分发证书。
     • open [project]/ios/Runner.xcworkspace/ 并选择目标设置窗格中的分发证书。
8. 为每个平台创建一个 Fastfile 脚本。

   • 在 Android 上，请按照 fastlane Android 测试版部署指南 进行操作。您的编辑可以像添加调用 upload_to_play_store 的 lane 一样简单。将 aab 参数设置为 ../build/app/outputs/bundle/release/app-release.aab 以使用 flutter build 已经构建的应用包。

   • 在 iOS 上，请按照 fastlane iOS 测试版部署指南 进行操作。您可以指定存档路径以避免重新构建项目。例如

     ruby

     build_app(
       skip_build_archive: true,
       archive_path: "../build/ios/archive/Runner.xcarchive",
     )
     upload_to_testflight

现在，您可以准备在本地执行部署或将部署过程迁移到持续集成 (CI) 系统。

1. 构建发布模式应用程序。
   • flutter build appbundle。
   • flutter build ipa。
2. 在每个平台上运行 Fastfile 脚本。
   • cd android 然后 fastlane [您创建的 lane 的名称]。
   • cd ios 然后 fastlane [您创建的 lane 的名称]。

首先，按照“本地设置”中描述的本地设置部分进行操作，以确保在迁移到 Travis 等云系统之前，该过程有效。

主要需要考虑的是，由于云实例是短暂的且不受信任的，因此您不会将 Play 商店服务帐户 JSON 或您的 iTunes 分发证书等凭据留在服务器上。

持续集成 (CI) 系统通常支持加密环境变量来存储私有数据。您可以在构建应用程序时使用 --dart-define MY_VAR=MY_VALUE 传递这些环境变量。

注意不要在测试脚本中将这些变量值重新回显到控制台。在合并到主分支之前，这些变量在拉取请求中也不可用，以确保恶意行为者无法创建打印这些密钥的拉取请求。请谨慎处理您接受和合并的拉取请求中与这些密钥的交互。

1. 使登录凭据短暂有效。

   • 在 Android 上
     • 从 Appfile 中删除 json_key_file 字段，并将 JSON 的字符串内容存储在 CI 系统的加密变量中。在您的 Fastfile 中直接读取环境变量。

       upload_to_play_store(
         ...
         json_key_data: ENV['<variable name>']
       )

     • 序列化您的上传密钥（例如，使用 base64）并将其保存为加密的环境变量。您可以在安装阶段使用以下方法在 CI 系统上对其进行反序列化
       bash

       echo "$PLAY_STORE_UPLOAD_KEY" | base64 --decode > [path to your upload keystore]

   • 在 iOS 上
     • 移动本地环境变量 FASTLANE_PASSWORD 以在 CI 系统上使用加密的环境变量。
     • CI 系统需要访问您的分发证书。建议使用 fastlane 的 Match 系统在机器之间同步您的证书。

2. 建议使用 Gemfile 而不是每次在 CI 系统上使用不确定的 gem install fastlane，以确保 fastlane 依赖项在本地和云机器之间稳定且可重现。但是，此步骤是可选的。

   • 在您的 [project]/android 和 [project]/ios 文件夹中，创建一个包含以下内容的 Gemfile

     source "https://rubygems.org.cn"
     
     gem "fastlane"

   • 在两个目录中，运行 bundle update 并将 Gemfile 和 Gemfile.lock 检入源代码控制。
   • 在本地运行时，使用 bundle exec fastlane 而不是 fastlane。

3. 在您的存储库根目录中创建 CI 测试脚本，例如 .travis.yml 或 .cirrus.yml。

   • 有关特定于 CI 的设置，请参阅 fastlane CI 文档。
   • 将您的脚本分成片段，以便在 Linux 和 macOS 平台上运行。
   • 在 CI 任务的设置阶段，执行以下操作
     • 使用 gem install bundler 确保 Bundler 可用。
     • 在 [project]/android 或 [project]/ios 中运行 bundle install。
     • 确保 Flutter SDK 可用并在 PATH 中设置。
     • 对于 Android，请确保 Android SDK 可用，并且已设置 ANDROID_SDK_ROOT 路径。
     • 对于 iOS，您可能需要指定对 Xcode 的依赖项（例如，osx_image: xcode9.2）。
   • 在 CI 任务的脚本阶段
     • 运行 flutter build appbundle 或 flutter build ios --release --no-codesign，具体取决于平台。
     • cd android 或 cd ios
     • bundle exec fastlane [lane 的名称]

Xcode Cloud 是一种持续集成和交付服务，用于构建、测试和分发 Apple 平台的应用程序和框架。

• Xcode 13.4.1 或更高版本。
• 已注册 Apple Developer Program。

Xcode Cloud 识别 自定义构建脚本，这些脚本可用于在指定时间执行其他任务。它还包含一组 预定义环境变量，例如 $CI_WORKSPACE，它是克隆存储库的位置。

利用克隆后自定义构建脚本，该脚本在 Xcode Cloud 克隆您的 Git 存储库后运行，请按照以下说明操作

在 ios/ci_scripts/ci_post_clone.sh 中创建一个文件，并添加以下内容。

#!/bin/sh

# Fail this script if any subcommand fails.
set -e

# The default execution directory of this script is the ci_scripts directory.
cd $CI_PRIMARY_REPOSITORY_PATH # change working directory to the root of your cloned repo.

# Install Flutter using git.
git clone https://github.com/flutter/flutter.git --depth 1 -b stable $HOME/flutter
export PATH="$PATH:$HOME/flutter/bin"

# Install Flutter artifacts for iOS (--ios), or macOS (--macos) platforms.
flutter precache --ios

# Install Flutter dependencies.
flutter pub get

# Install CocoaPods using Homebrew.
HOMEBREW_NO_AUTO_UPDATE=1 # disable homebrew's automatic updates.
brew install cocoapods

# Install CocoaPods dependencies.
cd ios && pod install # run `pod install` in the `ios` directory.

exit 0

此文件应添加到您的 git 存储库中并标记为可执行文件。

git add --chmod=+x ios/ci_scripts/ci_post_clone.sh

Xcode Cloud 工作流 定义了在触发工作流时 CI/CD 过程中执行的步骤。

要在 Xcode 中创建新的工作流，请使用以下说明

1. 选择产品 > Xcode Cloud > 创建工作流以打开创建工作流工作表。

2. 选择工作流应附加到的产品（应用程序），然后单击下一步按钮。

3. 下一个工作表显示了 Xcode 提供的默认工作流的概述，可以通过单击编辑工作流按钮进行自定义。

默认情况下，Xcode 建议使用分支更改条件，该条件会为 Git 存储库默认分支的每个更改启动新的构建。

对于您的应用程序的 iOS 变体，您可能希望 Xcode Cloud 在您更改 Flutter 包或修改 lib\ 和 ios\ 目录中的 Dart 或 iOS 源文件后触发您的工作流，这是合理的。

这可以通过使用以下文件和文件夹条件来实现

Xcode Cloud 会将新工作流的构建编号默认为 1，并在每次构建成功后递增。如果您正在使用具有更高构建编号的现有应用，则需要配置 Xcode Cloud 以使用其构建的正确构建编号，只需在您的迭代中指定 Next Build Number 即可。

查看为 Xcode Cloud 构建设置下一个构建编号以获取更多信息。

除非另有说明，否则本网站上的文档反映了 Flutter 的最新稳定版本。页面最后更新于 2024-06-11。 查看源代码 或 报告问题.