More than 1 year has passed since last update.

Unity Cloud BuildでTestFlight, Google Play Console, DeployGateへのデプロイを網羅する

Last updated at 2022-10-05Posted at 2022-10-05

はじめに

みなさんどうもこんにちは。プレティア・テクノロジーズでUnity Engineer をしているharuya_i と申します 🍵

この記事では、私が会社でおこなっているプロジェクトで「Unity Cloud Build を使ってCI/CD を整備したら、開発環境そこそこいい感じになった。やったー 😀」となった事例から、実際に私が何をやったか、どうやったか、をサクッとお話しできればと思っております。

この記事を読んできっと得られること

1. TestFlight, Google Play Console, DeployGate へのアプリ配布環境が整う
2. 「へぇ〜、Unity Cloud Build も悪くないね」感 😀

1つ目は言わずもがな、です。
2つ目は、世の中にJenkis やCircle CI、Bitrise といった非常に豊富な種類のCI/CDツールがあり、それぞれに良し悪し、向き不向きが少なからず存在します。それはもちろんUnity Cloud Build も同じです。
そんな良し悪しを比較検討して、皆さんは自分やチームにどのCI/CDツールを導入するべきかと選択する場面があるかと思います。そんな時に、「へぇ〜、Unity Cloud Build も悪くないね」 と思える判断材料の1つになるかもしれません。

私がやったこと

具体的には、
「Unity Cloud Build を使って、Git へのプッシュからTestFlight, Google Play Console(内部テスト), DeployGate へのアプリのデプロイを自動化した」
です。（長い🤦‍♂️）

簡単に図にすると以下のようなフローを整えました。

といいましても、そのほとんどは後述する「参考記事」の寄せ集めといった感じで、私自身が加筆した部分はわずかになります。（インターネットってすげー 😌）

前提

Untiy Cloud Buildで、任意のGitクライアントからipa、 apk（およびaab）ファイルをビルドするフローが完結していること

「Unity Cloud Build でアプリをビルドする方法が知りたいのに〜」という方は、後述するDeployGate へのデプロイを行うにあたって大変参考にさせていただいたこちらの記事が役に立つかと思います 💁‍♂️

環境はUnity 2020.3.26f1, macOS Montereyで行いました。
ただ、基本的にはUnity Cloud Build側の設定で色々変えられるので、皆さんの環境に合った設定をしていただければと思います 😌

さて、それでは早速行ってみましょう。

DeployGate へのデプロイ

DeployGate、便利ですよね。

Unity Cloud Build では、ビルドされたアプリをインストールできるリンクを生成する機能が元々備わっているのですが、
DeployGate にアプリをデプロイしておくと色々都合がいいです 😌

Unity Cloud Build からDeployGate へのデプロイは以下の記事が非常に参考になりました。

こちらの記事では、Unity Cloud Build の設定から丁寧に解説してくれているので、「Unity Cloud Build の設定からやりたいんだけどな〜」って人にとっても、とてもとてもありがたい記事となっております♫

さて、Unity Cloud Build側の設定が終わった後、Unityプロジェクトの好きなところに、好きな名前の以下のようなシェルスクリプト2つを配置します。
それぞれipa, apkファイルデプロイ用です。

ipa用シェルスクリプト

#!/bin/bash

echo "Deploy iOS app to deploygate"

build_number=`awk -F\\" '/"buildNumber"/{print $4}' build_manifest.json`
version_number=`awk -F: '/bundleVersion/{print $2}' ProjectSettings/ProjectSettings.asset | sed -e "s/ //g"`
commit_id=`awk -F\\" '/"scmCommitId"/{print $4}' build_manifest.json`
comment=`git show ${commit_id} --no-patch --pretty=%B`

curl \\
 -H "Authorization: token <YOUR API TOKEN>" \\
 -F "file=@$2/build.ipa" \\
 -F "message=${version_number} (${build_number}) by Unity Cloud Build
 ${comment}" \\
 -F "distribution_key=<YOUR KEY>" \\
 "<https://deploygate.com/api/users/<YOUR NAME>/apps>"

apk用シェルスクリプト

#!/bin/bash

echo "Deploy Android app to deploygate"

build_number=`awk -F\\" '/"buildNumber"/{print $4}' build_manifest.json`
version_number=`awk -F: '/bundleVersion/{print $2}' ProjectSettings/ProjectSettings.asset | sed -e "s/ //g"`
commit_id=`awk -F\\" '/"scmCommitId"/{print $4}' build_manifest.json`
comment=`git show ${commit_id} --no-patch --pretty=%B`

curl \\
 -H "Authorization: token <YOUR API TOKEN>" \\
 -F "file=@$2/<TARGET'S NAME>.apk" \\
 -F "message=${version_number} (${build_number}) by Unity Cloud Build
 ${comment}" \\
 -F "distribution_key=<YOUR KEY>" \\
 "<https://deploygate.com/api/users/<YOUR NAME>/apps>"

そして対象のUnity Cloud BuildターゲットのConfigurations にあるAdvanced Options > Post-Export Method に(任意のパス)/(任意のファイル名).shと記入します。
こうすることで、Unity Cloud Build がipa, apkファイルをビルドした後に、このシェルスクリプトが実行されます。

それぞれのシェルスクリプトにいくつか埋めてもらうところがあります。

<YOUR API TOKEN>
DeployGate のAPIトークンです。
DeployGate のダッシュボードの右下から見ることができるはずです。
<YOUR KEY>
アプリ配布ページにあるDistributio Key なるものです。
ぜひ、先ほども紹介したこちらのありがたい記事を参考にしていただけるとわかりやすいです 💁‍♂️
<YOUR NAME>
ここにはDeployGate に登録しているユーザー名が入ります。Organaization でアプリを配布する場合はそのOrganization名です。
ちなみに、私はここで数時間つまずいたのですが、このOrganization名はブラウザなどで表示されている名前とは別なので、DeployGate が提供しているList Your Organizations というREST API を使ってOrganization名を確認すると確実です👍
(Androidのみ) <TARGET'S NAME>
ipaファイルは決まってbuild.ipaというファイル名でビルドされるっぽいのですが、なぜだかわかりませんが少なくとも私の環境では、apkファイルはUnity Cloud Build のターゲット名に依存するようです。しかも、ターゲット名を途中で変えたとしても書き出されるapkファイル名は変わらずでした。
多分別でどこかに名前の情報を持ってるのでしょうが、あまりこだわるところでもないので、深追いはしませんでした。原因・解決方法分かる方おりましたらコメントいただけると嬉しいです 🤲

DeployGate へのデプロイは以上ですっ！😉

TestFlight へのデプロイ

続きましては、TestFlightへのデプロイです 💻

DeployGate でも十分アプリのテスト環境は整いますが、TestFlight だとApple ID のみでテストユーザーが追加できたり、結局アプリをApp Store Connect にアップロードするので、TestFlight でテストしておいた方が色々と都合がいいことありますよね。

そんなTestFlight へのデプロイですが、以下の@ramieさんのありがたい記事を参考にさせていただいております。
というかもうそのままです。（ありがたすぎる、、！🥹）

上記の記事で紹介されているこちらにあるように、

「輸出コンプライアンスの確認」チェックの回避
iOSビルド番号のインクリメント

をUnity のC#スクリプト側でやっておくと大変スムーズなのでオススメです 💁‍♂️

Google Play Console (内部テスト)へのデプロイ

TestFlight にもデプロイできたので、この流れでGoogle Play Console の内部テストにもデプロイしちゃいましょう♫

参考にさせていただいた記事は、以下のUnityフォーラムと、noteの記事です。

1つ目の記事ではUnity Cloud Build で使うシェルスクリプトについて、
2つ目の記事ではそのシェルスクリプト内で使うGoogle Play Console API のJSONキーの書き出し方法が説明されています。

Unityプロジェクトに配置するシェルスクリプトは以下のような感じです。ここではaabファイルを内部テストにデプロイしています。

aab用シェルスクリプト

#!/bin/bash
 
PACKAGE_NAME=$(cat "$WORKSPACE/build.json" | jq -j '.[].bundleid')
UNITY_PLAYER_PATH="$2/<TARGET'S NAME>.aab"
KEY_WITH_NEWLINES=$(echo $PLAYSTORE_KEY | jq '.private_key |= sub(" (?!PRIVATE|KEY)"; "\n"; "g")' -c -j)

fastlane supply \
--package_name "$PACKAGE_NAME" \
--aab "$UNITY_PLAYER_PATH"  \
--json_key_data "$KEY_WITH_NEWLINES" \
--release-status completed \
--track internal

Unity Cloud Build にあるConfigurations にて、Environment Variables を1つ追加する必要があります。key にPLAYSTORE_KEY、value にGoogle Play Console API のJSONキーを丸ごとぶち込みます。

私の方では試してはいないのですが、最後のコマンドの--track internalを
--track alphaや--track beta、--track productionにすれば、クローズドテストやオープンテスト、製品版にデプロイすることができるはずです 🧐

また、Google Play Console API の権限以外にも、[国/地域]が設定されていないとデプロイに失敗します。

この辺りやその他詳細については、以下のfastlane公式のドキュメントを読むのが良さそうです 😉

また、Google Play Console ではPlayerSettingsにあるBundleVersionCodeが同じapk/aabファイルはアップすることができないので、
例えば以下のように、OnPreprocessBuildなどでAndroidプラットフォームでのみBundleVersionCodeを自動的に上げる処理を書いておくと便利です。

public void OnPreprocessBuild(BuildReport buildReport)
{
#if UNITY_ANDROID
    PlayerSettings.Android.bundleVersionCode = Int32.Parse(DateTime.Now.ToString("yyyyMMddHH"));
#endif
    ...
}

さいごに

以上となります 😌🍵

Unity Cloud Build を使った開発は、個人や比較的小規模のチームではだいぶコスパ良く開発環境の改善ができるかと思いますので、もしよかったら試してみてください。

現在プレティア・テクノロジーズでは、「共に達成する喜びを届ける」というミッションを一緒に目指す仲間を絶賛募集しています。

グローバルな環境でARというチャレンジングな分野に積極果敢に取り組んでいます。私もMeetyでカジュアル面談をやってますので、よかったら気軽にまずは雑談でもしましょう 😌