GitHub Actions+Fastlaneでアプリをデプロイする

手順の解説

GitHub

GitLabで利用する方法もあるのですが、GitLabだとmacOSのランナーが課金するかオンプレにしないと使えないので今回はGitHubを利用します。

今回は作業用のレポジトリをapple-appstore-connect-testとして作成しました。

このレポジトリはパブリックでもプライベートでも構いません。

よくわかっていない方は上のレポジトリをクローンすれば同じ環境が作れます。

プライベートレポジトリ

GitLabではSecure Filesという仕組みでデータをセキュアに保存できたのですが、GitHubにはないので証明書を保存するためのレポジトリを作成します。

今回は証明書保存用のレポジトリをapple-appstore-connect-test-matchとして作成しました。

こちらのレポジトリは機密情報を含むため、必ずプライベートレポジトリにしてください

ACCESS_TOKEN

多分、ローカルでテストしたい場合に必要になります。

New personal access token (classic)から作成します。

今回は無限に使う予定だったので有効期限をなしにしましたが、どうせApple Developer Programは一年で切れるので一年間でも良いと思います。

スコープはよくわかっていないのですがとりあえずrepoにさえチェックが入っていれば動きます。

作成したらトークンの内容を何処かにコピーしておきます。

App Store Connect

App Store Connect APIからAPIキーを生成します。

このAPIキーを利用することで証明書を取得してくるという仕組みです。

従来、2FAが有効になっていると証明書の取得は大変にめんどくさかったのですがAPIキーを利用することでそれらのしがらみから解放されました。

これを使うことのメリットは公式ドキュメントに書いてあるので目を通すと良いかもしれません。

No 2FA needed
Better performance
Documented API
Increased reliability

はい、いいことしかありませんね。

APIキーを発行したらIssuer ID、Key IDの二つをコピーします。

そして最後にAPIキー自体をダウンロードします。このキーは一度ダウンロードすると二度とダウンロードできないので大切に保管してください。

ダウンロードしたらそのファイルをBase64でエンコードします。ただし、このファイル自体が機密情報なので間違ってもオンラインサービスなどでエンコードしないようにしましょう。

1
cat AuthKey_XXXXXXXX.p8 | base64

とコマンドを打てばエンコードされた文字列が表示されるので、この値をコピーします。

Base64自体は暗号化でもなんでもないのでやはりこのデータも機密情報となります。取り扱いには注意してください。

環境変数

ここまでできたら環境変数をGitHubのRepository secretsに登録します。

登録すべきデータは以下の五つです。ローカルで検証したい場合は.envに書き込んでしまっても良いでしょう。

キー	意味
MATCH_PASSWORD	パスワード
ASC_KEY_ID	キーID
ASC_ISSUER_ID	発行者ID
ASC_KEY_CONTENT	Base64した文字列
PRIVATE_TOKEN	アクセストークン

どうやらFastfileで利用するmatchはGitHub Actionsに渡されるGITHUB_TOKENではアクセスできないようでAccessible from repositories owned by the userの項目を変更してもアクセス権がないと表示されてしまった

もっと強い権限をアクセストークンに与えれば解決するかもしれないが、とりあえず保留しておく

ローカルで作業する場合は上の五つ加えてGITHUB_ACTORが必要になります。

これらの値を.envに書き込んでください。GITHUB_ACTORはGitHubのユーザー名になるので私の場合はtkgstratorとなります。

MATCH_PASSWORDは適当に1Passwordとかで強めのパスフレーズを作成して設定しておけば良いです。

Fastlane

ここからあとの作業はローカルで行います。

`init`

fastlane initを実行します。

1
[✔] 🚀
2
[✔] Looking for iOS and Android projects in current directory...
3
[10:28:57]: Created new folder './fastlane'.
4
[10:28:57]: Detected an iOS/macOS project in the current directory: 'TestApp.xcodeproj'
5
[10:28:57]: -----------------------------
6
[10:28:57]: --- Welcome to fastlane 🚀 ---
7
[10:28:57]: -----------------------------
8
[10:28:57]: fastlane can help you with all kinds of automation for your mobile app
9
[10:28:57]: We recommend automating one task first, and then gradually automating more over time
10
[10:28:57]: What would you like to use fastlane for?
11
1. 📸  Automate screenshots
12
2. 👩‍✈️  Automate beta distribution to TestFlight
13
3. 🚀  Automate App Store distribution
14
4. 🛠  Manual setup - manually setup your project to automate your tasks

今回はTestFlightにベータ版をデプロイしたいので2を選択します。

いろいろ出てきますがとりあえずエンターキーを押します。

1
fastlane/
2
├── Appfile
3
└── Fastfile

が作成されると思います。

`match init`

fastlane match initを実行します。

1
[✔] 🚀
2
[16:51:49]: fastlane match supports multiple storage modes, please select the one you want to use:
3
1. git
4
2. google_cloud
5
3. s3
6
4. gitlab_secure_files
7
?

今回はGitのプライベートレポジトリを利用するので1を選択します。

プライベートレポジトリを入力しろと言われるので今回の場合は**https://github.com/tkgstrator/apple-appstore-connect-test-match.git**と入力しました。

当たり前ですが、自身が管理するプライベートレポジトリを入力するように

途中でパスワードの入力を求められたらそれが先程設定したMATCH_PASSWORDになります。

これを入れないと対話式になってしまうのでGitHub Actionsでmatchができなくなります。

万が一間違った値を入力してしまってもfastlane match change_passwordでパスフレーズを初期化できるので安心してください。

`match`

とりあえず開発用と本番用の証明書があればよいと思うので、

1
fastlane match development
2
fastlane match appstore

で証明書を発行します。

発行数が上限に達してるよと言われた場合にはfastlane match nuke developmentとかすれば大丈夫です。

ただしappstoreの署名を取り消すにはfastlane match nuke distributionという罠があります。

Fastflie

1
fastlane/
2
├── Appfile
3
├── Fastfile
4
└── Matchfile

さて、上のようなファイルができていると思いますがここでFastfileだけ編集します。

その他はこのまま放置でオッケーです。

1
platform :ios do
2
  desc "Push a new beta build to TestFlight"
3
  lane :beta do
4
    setup_ci(provider: "travis")
5
    api_key = app_store_connect_api_key(
6
      key_id: ENV['ASC_KEY_ID'],
7
      issuer_id: ENV['ASC_ISSUER_ID'],
8
      key_content: ENV['ASC_KEY_CONTENT'],
9
      in_house: false,
10
      is_key_content_base64: true
11
    )
12
    match(
13
      git_basic_authorization: Base64.strict_encode64("#{ENV['GITHUB_ACTOR']}:#{ENV['GITHUB_TOKEN']}"),
14
      api_key: api_key,
15
      app_identifier: 'work.tkgstrator.TestApp',
16
      type: "appstore",
17
      readonly: is_ci
18
    )
19
    increment_build_number(xcodeproj: "TestApp.xcodeproj", build_number: latest_testflight_build_number + 1)
20
    build_app(scheme: "TestApp", export_method: "app-store", xcargs: "-allowProvisioningUpdates", output_directory: "build")
21
    upload_to_testflight(api_key: api_key, notify_external_testers: true, changelog: "Deploy by GitHub Actions.")
22
  end
23
end

自分でもよくわかっていないのですが、上のコードをそのまま書きます。

ただしapp_identifierやschemeやxcodeprojに関しては各自変更してください。

TestFlightであってもappstoreを指定しなければいけないのは個人的な謎ポイントではある

GitHub Actions

最後にGitHub Actionsで上のコードが実行されるようにします。

mkdir -p .github/workflowsでディレクトリを作成して、その中に適当にtestflight.yamlを作成しました。

1
name: Upload TestFlight
2

3
on:
4
  workflow_dispatch:
5
  push:
6
    branches:
7
      - master
8

9
jobs:
10
  build:
11
    runs-on: [macos-14]
12

13
    steps:
14
    - name: Checkout
15
      uses: actions/checkout@v4
16

17
    - name: Select Xcode version
18
      run: sudo xcode-select -s '/Applications/Xcode_15.2.app/Contents/Developer'
19

20
    - name: Show Xcode version
21
      run: xcodebuild -version
22

23
    - name: Cache
24
      uses: actions/cache@v4
25
      with:
26
        path: vendor/bundle
27
        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
28
        restore-keys: |
29
          ${{ runner.os }}-gems-
30

31
    - name: Bundle install
32
      run: |
33
        bundle config path vendor/bundle
34
        bundle install --jobs 4 --retry 3
35

36
    - name: Upload a new build to App Store Connect
37
      env:
38
        ASC_KEY_ID: ${{ secrets.ASC_KEY_ID }}
39
        ASC_ISSUER_ID: ${{ secrets.ASC_ISSUER_ID }}
40
        ASC_KEY_CONTENT: ${{ secrets.ASC_KEY_CONTENT }}
41
        MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
42
        GITHUB_TOKEN: ${{ secrets.PRIVATE_TOKEN }}
43
        GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}
44
      run: bundle exec fastlane beta

GITHUB_ACTORについては環境変数に最初から入っているので設定が不要というわけです。

PRIVATE_TOKENも利用しないようなコードに変えたい…GitHub Actionsからプライベートレポジトリを読み込めないのが問題…

あと、キャッシュがあんまり効いている気がしない、コピペしたけど間違ってないこれ？

記事は以上。