fastlane - tasuwo-ios

fastlane

概要

fastlane は、モバイルアプリのデプロイ時の様々なタスクを自動化してくれるツール。スクリーンショットの生成 (fastlane snapshot) や、コード署名 (fastlane match)、アプリのリリース等を自動化できる。

🚀 The easiest way to automate building and releasing your iOS and Android apps

https://github.com/fastlane/fastlane

概念

fastlane における主要な概念としては、Lane と Action がある。

table:概念

概念概要

Lane ある1まとまりの作業の流れ (テストの実行やビルド、デプロイ等) をまとめたもの

Action 実行可能な特定のタスク。通常 Lane から必要な Action を組み合わせて呼び出し作業を達成する

Lane は、テストの実行、特定の設定下でのビルド、DeployGate, TestFlight, App Store へのアップロード... 等、モバイル開発の上で必要となる一連の作業をまとめた単位になる。開発やあるいは CI/CD からは、必要に応じてfastlane コマンド経由で特定の Lane を実行することになる。

Action は、Lane から利用可能な特定のタスク。Lane 内で行う一連の作業の記載は、この Action の組み合わせで簡潔に記載できるようになっている。fastlane に最初から組み込まれた便利な Action が数多くあるが、必要に応じて自作することもできる。

設定ファイル

fastlane 関連の設定ファイルは、基本的にプロジェクト Root 下の ./fastlane に配置する。設定ファイルには以下のような種類がある。プロジェクトに初めて fastlane を導入する際に fastlane init を実行すると、Appfile と Fastfile は自動で生成される。Matchfile、Snapfile は、fastlane match、fastlane snapshot を利用する場合には必要になる。もっともよく触ることになるであろうファイルは Fastfile で、ここに各 Lane の定義を記載していくことになる。

table:設定ファイル

ファイル名概要

Appfile Apple ID や Bundle Identifier など、fastlane から利用するアプリ関連情報を記載する

Fastfile fastlane 経由で実行できる自動化内容を記載する

Matchfile fastlane match で利用する。管理する証明書類の格納先等を記載する

Snapfile fastlane snapshot で利用する。撮影対象のデバイスや撮影時の設定等を記載する

Scanfile scan action 用の設定ファイル

Deliverfile deliver action 用の設定ファイル

Gymfile gym action 用の設定ファイル

...etc

秘匿情報の管理

秘匿情報は環境変数経由で受け渡すのがよく、安全かつシンプルなのは dotenv を利用する方法のようだ。fastlane はその引数で env ファイルを受け渡すことができる。

code:.env

SLACK_URL="https://hooks.slack.com/services/T03NA19Q5/..."

CRASHLYTICS_API_TOKEN="123abc"

code:console

fastlane beta --env .env

https://docs.fastlane.tools/best-practices/keys/

ただし、.env ファイルに記載したいのが秘匿情報ばかりとは限らない。物によってはチームメンバと public に共有した方がやりやすいものもあるかもしれない。そのような場合には、public に公開可能な dotenv と、秘匿情報を分ける、という方法もある。--env オプションで受け渡せる .env ファイルは 1 つのみであるため、秘匿情報を管理した env は Fastfile 内で直接ロードすれば良い。

code:.env.secret

FL_GITHUB_RELEASE_API_TOKEN="hogehoge"

code:.env

SLACK_URL="https://hooks.slack.com/services/T03NA19Q5/..."

code:Fastfile.rb

fastlane_require("dotenv")

Dotenv.load(".env.secret")

# ENV'FL_GITHUB_RELEASE_API_TOKEN' が読み取れる

https://www.joshholtz.com/altconf-fastlane-best-practices/#slide=11

fastlane を導入する

インストールする gem のバージョンを複数の環境で揃えるために Bundler を利用すると良い。

code:console