♒️ ♻️ 🧒🏽 Gitlab CIを使用してAndroidおよびiOS用のUnityプロジェクトを自動的にビルドする 💬 🛥️ ☪️

この記事では、macOSを使用したネイティブビルドでGitlabを介してAndroidおよびiOSでUnityプロジェクトをビルドする方法について説明します。

私は小さなゲーム開発会社で働いていますが、次の問題が原因でアセンブリを自動化するタスクが現れました。

5つの分散チームは、世界中のどこからでもプロジェクトを収集する必要があります
異なるユニットバージョンをサポートする必要があります
アセンブラーは各チームから少なくとも週に5つのアセンブリを提供する必要があります
証明書は開発者ではなく中央に保存する必要があります
収集されたビルドは、世界中のどこからでも参照によりアクセス可能でなければなりません
プロジェクトで必要なライブラリの存在を確認する必要があります（広告SDKとコード、ローカリゼーション、保存）
コマンドのアセンブリ構成は1か所で行う必要があります

これらの問題を解決するために、Unity Cloud Build、TeamCity、Jenkins、Gitlab CI、Bitbucket Pipelinesなどの既製のソリューションが既に作成されています。

最初のものは、Unityプロジェクトのアセンブリ用に準備されていますが、証明書を使用した作業の自動化は許可されておらず、プロジェクトごとに手動で入力する必要があります。 TeamCityとJenkinsでは、管理領域でプロジェクトを設定し（これにより開発者の構成が少し複雑になります）、別のサーバーに追加のソフトウェアをインストールし、そのサポートを行う必要があります。その結果、GitlabとBitbucketの2つのオプションを実装するのが最も簡単で最速でした。
問題が解決した時点では、Bitbucket Pipelinesはまだ発表されていなかったため、Gitlabを使用することが決定されました。

このアプローチを実装するために、次の手順が実行されました。

プロジェクトのセットアップ
ランナー設定
ビルドスクリプトの作成

1.プロジェクトのセットアップ

コレクターで収集されたプロジェクトは、Gitlabに保存されます。サービスの無料版は、リポジトリ自体とその数を制限しません。
各プロジェクトには、ポピーで実行されるランナー（gitlabサーバーからコマンドを実行するサービス）が含まれています。
コレクターの構成は、.gitlab-ci.ymlファイルとしてプロジェクトのルートにあります。アプリケーションID、必要な署名ID（AndroidのキーストアとiOSのアカウント名）、必要なUnityバージョン、ブランチ、起動モード：手動または自動、およびアセンブリを開始するコマンド（必要に応じて、gitlabはより多くのパラメーター、ドキュメントをサポート）について説明します。

サンプル.gitlab-ci.yml構成ファイル

variables: BUNDLE: com.banana4apps.evolution SIGNING: banana4apps UNITY_VERSION: 2017.1 build:android: script: - buildAndroid.sh $BUNDLE $SIGNING $UNITY_VERSION only: - releaseAndroid when: manual build:ios: script: - buildIOS.sh $BUNDLE $SIGNING $UNITY_VERSION only: - releaseIOS when: manual

2.ランナーのセットアップ

Gitlab CIは、共有ランナーと独自のランナーで動作します（ドキュメント）。無料版では、共有ランナーの使用時間に制限がありますが、独自のランナーを無制限に使用できます。共有ランナーはLinux上で実行されるため、iOSアプリケーションをそれらでアセンブルすることはできません（ただし、Unityは成功します。ハブに関する記事がありました）。このため、私は自分のポピーでランナーを上げる必要がありました。上記の例では、ランナーはbuildAndroid.shまたはbuildIOS.shスクリプト（ブランチによって異なる）を実行します。これは、準備手順、Unityの起動、ビルド結果の通知を記述しています。
ランナーの設定プロセスはドキュメントにgitlab-runner install説明されており、 gitlab-runner installおよびgitlab-runner startます。
その後、必要なUnityバージョンがポピーにインストールされます。

3.ビルドスクリプトの作成

プラットフォームごとに、ビルドプロセスの違いにより、独自のスクリプトを作成する必要がありました。ただし、アルゴリズムは同じです。

プロジェクトIDの正確性、目的の署名IDの証明書の可用性を確認します
SDK、Javaへのパスを定義する
アセンブリを開始するメソッドを使用してC＃プロジェクトにクラスを作成します
Unityの必要なバージョンの可用性を確認し、アセンブリを実行します。そうでない場合は、デフォルトバージョンでビルドしてみてください
apkまたはXcodeプロジェクトの可用性を確認し、存在しない場合はSlackでエラーを通知します
iOSの場合：Xcodeプロジェクトの構築
アーティファクト（apk、ipa）をサーバー（Amazon S3など）にアップロードします
Slackでビルドが成功したことを通知し、アーティファクトをダウンロードするためのリンクを送信します

Unityプロジェクトをビルドする特性は、Unityをバッチモードで使用すると、プロジェクトで使用可能なクラスの静的メソッドのみを実行できることです。したがって、アセンブリスクリプトは、アセンブリを開始するためのメソッドを含むクラスをプロジェクトに「スロー」します。

CustomBuild.cs

 public class CustomBuild { static string outputProjectsFolder = Environment.GetEnvironmentVariable("OutputDirectory"); static string xcodeProjectsFolder = Environment.GetEnvironmentVariable("XcodeDirectory"); static void BuildAndroid() { BuildTarget target = BuildTarget.Android; EditorUserBuildSettings.SwitchActiveBuildTarget(target); PlayerSettings.applicationIdentifier = Environment.GetEnvironmentVariable("AppBundle"); PlayerSettings.Android.keystoreName = Environment.GetEnvironmentVariable("KeystoreName"); PlayerSettings.Android.keystorePass = Environment.GetEnvironmentVariable("KeystorePassword"); PlayerSettings.Android.keyaliasName = Environment.GetEnvironmentVariable("KeyAlias"); PlayerSettings.Android.keyaliasPass = Environment.GetEnvironmentVariable("KeyPassword"); BuildPipeline.BuildPlayer(GetScenes(), string.Format("{0}/{1}.apk" , outputProjectsFolder, PlayerSettings.applicationIdentifier), target, options); } static void BuildIOS() { BuildTarget target = BuildTarget.iOS; EditorUserBuildSettings.SwitchActiveBuildTarget(target); PlayerSettings.applicationIdentifier = Environment.GetEnvironmentVariable("AppBundle"); PlayerSettings.iOS.appleDeveloperTeamID = Environment.GetEnvironmentVariable("GymTeamId"); BuildPipeline.BuildPlayer(GetScenes(), xcodeProjectsFolder, target, options); } //        static string[] GetScenes() { var projectScenes = EditorBuildSettings.scenes; List<string> scenesToBuild = new List<string>(); for (int i = 0; i < projectScenes.Length; i++) { if (projectScenes[i].enabled) { scenesToBuild.Add(projectScenes[i].path); } } return scenesToBuild.ToArray(); } }

Environment.GetEnvironmentVariableメソッドは、bashスクリプトで以前に指定された環境変数の値を取得します。

Androidビルドスクリプトの例

buildAndroid.sh

 GREEN='\033[0;32m' RED='\033[0;33m' NC='\033[0m' # No Color export COMMIT=$(git log -1 --oneline —no-merges) if [ "$1" = "" ]; then echo -e "${RED}You must provide application Id${NC}" exit 1 fi export ANDROID_HOME=/Library/Android export OutputDirectory=./ export AppBundle=$1 if [ "$2" = "account1" ]; then export KeystoreName="$CI_DATA_PATH/keystores/account1.keystore" export KeystorePassword="..." export KeyAlias="..." export KeyPassword="..." elif [ "$2" = "account2" ]; then export KeystoreName="$CI_DATA_PATH/keystores/account2.keystore" export KeystorePassword="..." export KeyAlias="..." export KeyPassword="..." else echo "${RED}No keystore config found for $2${NC}" exit 1 fi echo -e "${GREEN}BundleId: ${AppBundle}${NC}" echo -e "${GREEN}Signing: ${KeyAlias}${NC}" #      mkdir -p $CI_PROJECT_DIR/Assets/Editor && cp $CI_DATA_PATH/CustomBuild.cs "$_" #   Unity if [ "$3" = "5.5" ]; then /Applications/Unity5.5/Unity.app/Contents/MacOS/Unity -buildTarget android -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.Android -quit -logFile /dev/stdout -username "..." -password "..." elif [ "$3" = "2017.1" ]; then /Applications/Unity2017.1/Unity.app/Contents/MacOS/Unity -buildTarget android -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.Android -quit -logFile /dev/stdout -username "..." -password "..." else /Applications/Unity5.6.4/Unity.app/Contents/MacOS/Unity -buildTarget android -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.Android -quit -logFile /dev/stdout -username "..." -password "..." fi #  ,   apk export APK="${CI_PROJECT_DIR}/${OutputDirectory}/${AppBundle}.${CI_BUILD_ID}.apk" echo "Testing apk exists: ${APK}..." if [ -f ${APK} ]; then echo -e "${GREEN}BUILD FOR ANDROID SUCCESS${NC}" #  apk      aws s3 cp ${APK} s3://ci-data/android/${AppBundle}.${CI_BUILD_ID}.apk --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers echo "<html><title>Download apk: ${AppBundle}</title><body><a href=\"https://ci-data.s3.amazonaws.com/android/${AppBundle}.${CI_BUILD_ID}.apk\">Install<br><br><strong>${AppBundle}</strong><br><small>${COMMIT}<br>(build ${CI_BUILD_ID} - android)</small></a></body></html>" >> ${CI_PROJECT_DIR}/download.html #  html      aws s3 cp ${CI_PROJECT_DIR}/download.html s3://ci-data/android/${AppBundle}.${CI_BUILD_ID}.html --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers #    Slack ${CI_DATA_PATH}/notifySlack.sh android success "https://ci-data.s3.amazonaws.com/android/${AppBundle}.${CI_BUILD_ID}.html" exit 0 else echo -e "${RED}BUILD FOR ANDROID FAILED${NC}" ${CI_DATA_PATH}/notifySlack.sh android failure exit 1 fi

iOS用のサンプルビルドスクリプト
プロジェクトのアセンブリは、UnityからのXcodeプロジェクトの形成とXcodeプロジェクトのアセンブリという2つのステップで実行されます。開発者はXcodeプロジェクトに直接影響を与えることはできません。これは制限をもたらします。プロジェクト設定、アセンブリ情報を直接変更することはできません。
また、iOSのビルド機能では、テストデバイスをアプリケーションのプロビジョニングプロファイルに登録する必要があります。 Xcodeプロジェクトをビルドするには、ビルドする前にAppleの開発者コンソールで証明書、プロビジョニングプロファイル、およびアプリケーションIDを作成する必要があります。
Fastlaneは、このプロセスを自動化するために使用されます。このツールは、証明書とプロファイルを作成および同期し、ビルドとメタ情報をiTunes Connectにアップロードできるようにします。

XcodeにアクセスせずにUnityプロジェクトを構築する場合、微妙な違いがあります。

Unityでは、プロジェクトをビルドする前に、開発者のコンソールにあるTeamIdを指定する必要があります-これはPlayerSettings.iOS.appleDeveloperTeamIDを介して行われます
後処理プロジェクトスクリプトでは、Xcodeプロジェクトを前処理する必要があります。info.plistを構成し、設定をビルドします
リリースとアドホックビルドには、結果の形成が異なるスクリプトもあります。リリースは、iTunes Connectでアーカイブをダウンロードし、IPAをアドホックダウンロードし、マニフェストとダウンロードページを無線で作成し、すべての関係者にリンクが送信されます。

アドホックビルド：buildAdhocIOS.sh

 GREEN='\033[0;32m' RED='\033[0;33m' NC='\033[0m' # No Color export COMMIT=$(git log -1 --oneline --no-merges) if [ "$1" = "" ]; then echo -e "${RED}You must provide application Id${NC}" exit 1 fi if [ "$2" = "account1" ]; then #    fastlane  export AccountName="account email" export AccountDesc="account description" export FastlanePassword="..." export GymExportTeamId="..." export FastlaneRepository="fastlane-keys.git" export ProduceTeamName="team name" else echo "${RED}No keystore config found for $2${NC}" exit 1 fi echo -e "${GREEN}BundleId: ${AppBundle}${NC}" echo -e "${GREEN}Account: ${AccountDesc} (${2})${NC}" #      mkdir -p $CI_PROJECT_DIR/Assets/Editor && cp $CI_DATA_PATH/CustomBuild.cs "$_" #   Unity if [ "$3" = "5.5" ]; then /Applications/Unity5.5/Unity.app/Contents/MacOS/Unity -buildTarget ios -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.IOS -quit -logFile /dev/stdout -username "..." -password "..." elif [ "$3" = "2017.1" ]; then /Applications/Unity2017.1/Unity.app/Contents/MacOS/Unity -buildTarget ios -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.IOS -quit -logFile /dev/stdout -username "..." -password "..." else /Applications/Unity5.6.4/Unity.app/Contents/MacOS/Unity -buildTarget ios -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.IOS -quit -logFile /dev/stdout -username "..." -password "..." fi # ,  Unity  XCode  XCODE_FILES="${CI_PROJECT_DIR}/${XcodeDirectory}" if [ -d ${XCODE_FILES} ]; then #    Apple Developer Console export PRODUCE_APP_IDENTIFIER=${AppBundle} export PRODUCE_APP_NAME=${AppBundle} export PRODUCE_USERNAME=${AccountName} export PRODUCE_SKU=${AppBundle} # skip_itc     itunes connect -  adhoc   fastlane produce --app_version "1.0" --language "English" --skip_itc #    code signing keys and profiles cd "${CI_PROJECT_DIR}/${XcodeDirectory}" rm -f Matchfile echo "git_url \"${FastlaneRepository}\"" >> Matchfile echo "app_identifier [\"${AppBundle}\"]" >> Matchfile echo "username \"${AccountName}\"" >> Matchfile # ,      export MATCH_PASSWORD='...' #     ,    # force_for_new_devices true     ,    developer console fastlane match adhoc --force_for_new_devices true #  Gymfile   XCode project   Ad-Hoc  rm -f Gymfile echo "export_options(" >> Gymfile echo " manifest: {" >> Gymfile echo " appURL: \"https://ci-data.s3.amazonaws.com/ios/${AppBundle}.${CI_BUILD_ID}.ipa\"," >> Gymfile echo " displayImageURL: \"https://ci-data.s3.amazonaws.com/ios-icon.png\"," >> Gymfile echo " fullSizeImageURL: \"https://ci-data.s3.amazonaws.com/ios-icon-big.png\"" >> Gymfile echo " }," >> Gymfile echo ")" >> Gymfile fastlane gym --scheme "Unity-iPhone" --export_method ${GYM_EXPORT_METHOD} --xcargs "DEVELOPMENT_TEAM=\"${GYM_EXPORT_TEAM_ID}\" PROVISIONING_PROFILE_SPECIFIER=\"match AdHoc ${AppBundle}\" CODE_SIGN_IDENTITY=\"iPhone Distribution: ${AccountDesc}\"" -o "${CI_PROJECT_DIR}/" -n "${AppBundle}.${CI_BUILD_ID}.ipa" #      S3 export IPA="${CI_PROJECT_DIR}/${AppBundle}.${CI_BUILD_ID}.ipa" ls -l "${CI_PROJECT_DIR}/${XcodeDirectory}/*.ipa" echo "Testing ipa exists: ${IPA}..." if [ -f ${IPA} ]; then echo -e "Begin uploading to S3..." aws s3 cp ${CI_PROJECT_DIR}/${AppBundle}.${CI_BUILD_ID}.ipa s3://ci-data/ios/${AppBundle}.${CI_BUILD_ID}.ipa --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers aws s3 cp ${CI_PROJECT_DIR}/manifest.plist s3://ci-data/ios/${AppBundle}.${CI_BUILD_ID}.plist --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers echo "<html><title>Download ipa: ${AppBundle}</title>" >> ${CI_PROJECT_DIR}/download.html echo "<body><a href=\"itms-services://?action=download-manifest&url=https://ci-data.s3.amazonaws.com/ios/${AppBundle}.${CI_BUILD_ID}.plist\">Install<br><br><strong>${AppBundle}</strong><br><small>${COMMIT}<br>(build ${CI_BUILD_ID} - iOS)</small></a></body></html>" >> ${CI_PROJECT_DIR}/download.html aws s3 cp ${CI_PROJECT_DIR}/download.html s3://ci-data/ios/${AppBundle}.${CI_BUILD_ID}.html --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers ${CI_DATA_PATH}/notifySlack.sh ios ad-hoc "https://ci-data.s3.amazonaws.com/ios/${AppBundle}.${CI_BUILD_ID}.html" echo -e "${GREEN}BUILD AD-HOC FOR IOS SUCCESS${NC}" exit 0 else echo -e "${RED}BUILD AD-HOC FOR IOS FAILED${NC}" ${CI_DATA_PATH}/notifySlack.sh ios failure exit 1 fi else echo -e "${RED}BUILD FOR IOS FAILED${NC}" ${CI_DATA_PATH}/notifySlack.sh ios failure exit 1 fi

リリースビルド：buildIOS.sh

 GREEN='\033[0;32m' RED='\033[0;33m' NC='\033[0m' # No Color export COMMIT=$(git log -1 --oneline --no-merges) if [ "$1" = "" ]; then echo -e "${RED}You must provide application Id${NC}" exit 1 fi if [ "$2" = "account1" ]; then #    fastlane  export AccountName="account email" export AccountDesc="account description" export FastlanePassword="..." export GymExportTeamId="..." export FastlaneRepository="fastlane-keys.git" export ProduceTeamName="team name" else echo "${RED}No keystore config found for $2${NC}" exit 1 fi echo -e "${GREEN}BundleId: ${AppBundle}${NC}" echo -e "${GREEN}Account: ${AccountDesc} (${2})${NC}" #      mkdir -p $CI_PROJECT_DIR/Assets/Editor && cp $CI_DATA_PATH/CustomBuild.cs "$_" #   Unity if [ "$3" = "5.5" ]; then /Applications/Unity5.5/Unity.app/Contents/MacOS/Unity -buildTarget ios -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.IOS -quit -logFile /dev/stdout -username "..." -password "..." elif [ "$3" = "2017.1" ]; then /Applications/Unity2017.1/Unity.app/Contents/MacOS/Unity -buildTarget ios -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.IOS -quit -logFile /dev/stdout -username "..." -password "..." else /Applications/Unity5.6.4/Unity.app/Contents/MacOS/Unity -buildTarget ios -projectPath $CI_PROJECT_DIR -batchmode -executeMethod CustomBuild.IOS -quit -logFile /dev/stdout -username "..." -password "..." fi # ,  Unity  XCode  XCODE_FILES="${CI_PROJECT_DIR}/${XcodeDirectory}" if [ -d ${XCODE_FILES} ]; then #    Apple Developer Console and Itunes Connect export PRODUCE_APP_IDENTIFIER=${AppBundle} export PRODUCE_APP_NAME=${AppBundle} export PRODUCE_USERNAME=${AccountName} export PRODUCE_SKU=${AppBundle} fastlane produce --app_version "1.0" --language "English" #    code signing keys and profiles cd "${CI_PROJECT_DIR}/${XcodeDirectory}" rm -f Matchfile echo "git_url \"${FastlaneRepository}\"" >> Matchfile echo "app_identifier [\"${AppBundle}\"]" >> Matchfile echo "username \"${AccountName}\"" >> Matchfile # ,      export MATCH_PASSWORD='...' #    fastlane match appstore #   XCode fastlane gym --scheme "Unity-iPhone" --xcargs "DEVELOPMENT_TEAM=\"${GymExportTeamId}\" PROVISIONING_PROFILE_SPECIFIER=\"match AppStore ${AppBundle}\" CODE_SIGN_IDENTITY=\"iPhone Distribution: ${AccountDesc}\"" -o "${CI_PROJECT_DIR}/" -n "${AppBundle}.${CI_BUILD_ID}.ipa" #   itunes connect export IPA="${CI_PROJECT_DIR}/${AppBundle}.${CI_BUILD_ID}.ipa" ls -l "${CI_PROJECT_DIR}/${XcodeDirectory}/*.ipa" echo "Testing ipa exists: ${IPA}..." if [ -f ${IPA} ]; then rm -f Deliverfile echo "app_identifier \"${AppBundle}\"" >> Deliverfile echo "username \"${AccountName}\"" >> Deliverfile echo "ipa \"${IPA}\"" >> Deliverfile echo "submit_for_review false" >> Deliverfile echo "force true" >> Deliverfile fastlane deliver echo -e "${GREEN}BUILD FOR IOS SUCCESS${NC}" exit 0 else echo -e "${RED}BUILD FOR IOS FAILED${NC}" ${CI_DATA_PATH}/notifySlack.sh ios failure exit 1 fi else echo -e "${RED}BUILD FOR IOS FAILED${NC}" ${CI_DATA_PATH}/notifySlack.sh ios failure exit 1 fi

他の人がこのシステムでどのように働くか

開発者は、テンプレートファイル.gitlab-ci.ymlをプロジェクトルートに追加し、gitlab.comのプロジェクト設定にランナーを含め、コードを目的のブランチにプッシュします。
ゲームデザイナーとテスターは、アセンブリの成功に関する通知と、Slackでapkおよびipaアーカイブをダウンロードするためのリンクを受け取ります。
私はビルドを追跡し、ログを確認し、開発者がバグに対処するのを助けることができます。ログと実行中のビルドは、gitlabで直接確認できます。マイナスの-今、インターフェイスでは、特定のランナーのビルドキューを見ることができません。

ビルドログを表示するためのインターフェイス：

結果

したがって、結果のシステムは使いやすく、サーバー側からチェックと検証を追加できます（コードスタイル、テスト）。マネージャーはSlackのアセンブリへのリンクを表示し、iOSのアセンブリに問題はありません。

マイナス-そのサポートは、Unityの新しいバージョンを追加し、IDに署名し、ケシの健康を確保するために必要です。

現在、2人のランナーが働いており（約2年）、4000を超えるアセンブリがシステムを通過しています。ビルド速度は、ランナーの特性とプロジェクト内のアセットの数に依存します。これらは毎回インポートされ、Androidでは3〜30分、iOSでは10〜60分で変化するためです。

Gitlab CIを使用してAndroidおよびiOS用のUnityプロジェクトを自動的にビルドする

1.プロジェクトのセットアップ

2.ランナーのセットアップ

3.ビルドスクリプトの作成

他の人がこのシステムでどのように働くか

結果

More articles: