CI ツールによるビルド作業の効率化①　Jenkins

　Jenkins(ジェンキンス) や Github Actions などの CI ツールを活用することで、ブランチの更新に合わせてビルドを自動化したり、
あるいは Unity を使わず、プラットフォームの切り替えを行わずにビルド作業を行うといったことが可能になります。

　こちらの記事では、Android と Addressables ビルドを Jenkins で行う方法を紹介します。
ブランチのマージにフックさせることで(例えば、 develop ブランチがマージされるたびに) Jenkins でビルドを自動的に作成することも応用できます。

Jenkins の導入

　公式サイトよりダウンロードして、インストールを行ってください。

Jenkins
https://www.jenkins.io/

　また Java がインストールされていない場合にも、そちらをダウンロードしてインストールする必要があります。
現時点(2025.1月) では、Java 17 と 23 のインストールが必要になります。

　Jenkins のインストールの流れについては、下記のサイトなどを参考にするとわかりやすいです

Qiita @taiyang-ks(太陽) 様
【Jenkins】WindowsにJenkinsをインストール
https://qiita.com/taiyang-ks/items/95ca67334b1b409...

Unity3d plugin の導入

　Jenkins には Untiy 用のプラグインが用意されていますので、こちらをインストールします。(その時の最新バージョンをインストールすれば大丈夫です。)
また、Unity の Editor の場所を指定しておくことで、その Unity を利用してビルドを行います。

　この指定はフォルダ単位です。Unity のバージョン名のフォルダまでを指定してください。
直接 Unity.exe ファイルを指定するとエラーになります。

　この辺りの手順については、下記のサイトが参考になります。

Hatena Blog YAMADA TAISHI’s diary 様
Unity1WeekJamに参加する前に自動ビルドを導入しよう
https://orotiyamatano.hatenablog.com/entry/2019/11...

CommandLineArgs と Build Script の作成

　CommandLineArgs クラスと Build Script クラスを作成します。

　どちらも Assets/Editor 内に配置します。

　
　これらのクラスについては、下記のサイトを参考にしています。

Hatena Blog YAMADA TAISHI’s diary 様
Unity1WeekJamに参加する前に自動ビルドを導入しよう
https://orotiyamatano.hatenablog.com/entry/2019/11...

Zenn shirokuma1101 様
Jenkins+PythonでUnityの自動ビルド&自動デプロイ
https://zenn.dev/kd_gamegikenblg/articles/c8b89f31...

CommandLineArgs.cs

　Addressables を利用していない場合には、using から削除してください。

using System;
using UnityEditor;
using UnityEditor.AddressableAssets.Settings;
using UnityEditor.Build.Reporting;
using UnityEngine;

public static class CommandLineArgs {
    public static string GetValue(string name) {
        var args = Environment.GetCommandLineArgs();
        for (int i = 0; i < args.Length; i++) {
            if (args[i] == $"-{name}" && args.Length > i + 1) {
                return args[i + 1];
            }
        }
        return null;
    }
}

Build Script.cs

　こちらも Addressables を利用していない場合には、using から削除し、処理内部のコメントアウトなどを行ってください。

using System.IO;
using System.Linq;
using UnityEditor;
using UnityEngine;
using UnityEditor.AddressableAssets.Settings;
using UnityEditor.AddressableAssets;
using UnityEditor.AddressableAssets.Build;

public static class BuildScript {

    [System.Obsolete]
    public static void Build() {

        // Addressables ビルド
        string addressablesPath = BuildAddressables();
        Debug.Log($"Addressables build output: {addressablesPath}");

        PlayerSettings.SetScriptingDefineSymbolsForGroup(BuildTargetGroup.Android, ""); // Android 用設定 

        // Jenkins 上の Editor command line arguments でバージョン指定
        const string BUILD_VERSION = "buildVersion";
        string buildVersion = CommandLineArgs.GetValue(BUILD_VERSION) ?? "0.1"; // デフォルト値: 0.1
        Debug.Log($"&#128313; ビルドバージョン: {buildVersion}");

        PlayerSettings.bundleVersion = buildVersion; // アプリのバージョン設定

        const string PRODUCT_NAME = "productName";
        string productName = CommandLineArgs.GetValue(PRODUCT_NAME) ?? Application.productName;
        PlayerSettings.productName = productName;

        string path = $"../output/{productName}.apk"; // 出力先を APK ファイルに変更
        FolderCreate(Path.GetDirectoryName(path)); // フォルダ生成


        BuildPlayerOptions buildOption = new BuildPlayerOptions {
            options = BuildOptions.CompressWithLz4, // 圧縮オプションを追加
            scenes = GetAllScenePaths(),
            target = BuildTarget.Android, // Android 用ターゲット
            locationPathName = path,
        };
        UnityEditor.Build.Reporting.BuildReport reports = BuildPipeline.BuildPlayer(buildOption);

        bool isSuccess = (reports.summary.result == UnityEditor.Build.Reporting.BuildResult.Succeeded);

        Debug.Log("isSuccess:" + isSuccess);

        AssetDatabase.SaveAssets();

        // レポートを元に成功・失敗に応じた処理のハンドリング
        switch (reports.summary.result) {
            case BuildResult.Succeeded:
                Debug.Log("&#9989; Build succeeded.");
                EditorApplication.Exit(0); // 正常終了
                break;

            case BuildResult.Failed:
                Debug.LogError("&#10060; Build failed.");
                EditorApplication.Exit(1); // エラー終了
                break;

            case BuildResult.Cancelled:
                Debug.LogError("&#9888;&#65039; Build canceled.");
                EditorApplication.Exit(1); // キャンセルもエラー扱い
                break;

            default:
                Debug.LogError("&#10067; Build result unknown.");
                EditorApplication.Exit(1); // 不明な場合もエラー終了
                break;
        }
    }

    /// <summary>
    /// 出力先フォルダ生成
    /// </summary>
    /// <param name="path"></param>
    public static void FolderCreate(string path) {
        if (!Directory.Exists(path)) {
            Directory.CreateDirectory(path);
        }
    }

    // GetAllScenePaths
    public static string[] GetAllScenePaths() {
        var levels = EditorBuildSettings.scenes
            .Where(scene => scene.enabled)
            .Select(scene => scene.path)
            .ToArray();

        return levels;
    }

    public static string BuildAddressables() {
        Debug.Log("Building Addressables...");

        // Addressables の設定を取得
        AddressableAssetSettings settings = AddressableAssetSettingsDefaultObject.Settings;
        if (settings == null) {
            Debug.LogError("AddressableAssetSettings is not found.");
            return string.Empty;
        }

        // ビルド用の Profile を設定(Jenkins の CommandLine で指定する場合には、BandleVersion などを参考に書き換えてください。)
        string remoteProfileName = "Remote Profile"; // Profile の名前
        string profileId = settings.profileSettings.GetProfileId(remoteProfileName);

        if (string.IsNullOrEmpty(profileId)) {
            Debug.LogError($"Profile '{remoteProfileName}' not found.");
            return string.Empty;
        }

        settings.activeProfileId = profileId; // Remote Profile を適用
        Debug.Log($"Using Addressables Profile: {remoteProfileName}");

        // Addressables のビルドを実行
        AddressableAssetSettings.BuildPlayerContent(out AddressablesPlayerBuildResult result);

        if (!string.IsNullOrEmpty(result.Error)) {
            Debug.LogError("Addressables build failed: " + result.Error);
            return string.Empty;
        }

        Debug.Log("Addressables build completed.");
        return result.OutputPath;
    }


    [MenuItem("Build/Build Develop App")]
    [System.Obsolete]
    public static void BuildApp() {
        Build();
    }
}

ジョブの作成

　Jenkins を利用して Unity のビルドを行う場合、Jenkins 内にジョブを作成して作業させます。

　こちらも先ほどのサイトを参考にして設定をおこなってください。
ソースコード管理は Git を指定し、Github のリポジトリを指定します。
HTTPS でも問題ありませんが、private リポジトリの場合には、アクセストークンなどを指定する必要があります。

　
　Unity3D plugin をインストールしておくと、Build Steps の ビルド手順の追加 項目内にて Invoke Unity3d Editor を選択できます。
こちらに Jenkins から実行させたい Unity のビルド処理を登録できます。

　Unity3d installation name には、実行する Unity のバージョンを記載しておくとよいでしょう。Unity 6000 といった簡易な名称で問題ありません。

　Editor command line arguments には、Unity 内の Editor フォルダ内に用意したビルド用のクラスとメソッドを登録することができます。
このときに指定可能なクラスは static クラスで作成し、メソッドも public static メソッドとして作成しておきます。

　"C:\Program Files\Unity\Hub\Editor\6000.0.32f1\Editor\Unity.exe" -batchmode -quit -projectPath "D:\[Unity_Projects]\[Addressables_Test]" -executeMethod BuildScript.Build -buildVersion "1.0.3"

　最初にビルドに利用する Unity Editor のパスを指定します。" " で囲み、ここでは Unity.exe まで指定します。
この Editor は Unity3D plugin で指定したものと同じ Unity Editor バージョンを指定します。
この例であれば "C:\Program Files\Unity\Hub\Editor\6000.0.32f1\Editor\Unity.exe" です。

　半角スペースを空け、-batchmode -quit と記述します。
これにより、Unity Editor を起動せず、Jenkins 経由でビルドを行うバッチモードが動きます。

　同じ様にまた半角スペースを空け、ビルド対象となるプロジェクトのパスを指定します。" " で囲み、プロジェクトのフォルダ名までを指定します。
この例であれば、"D:\[Unity_Projects]\[Addressables_Test]" です。

　最後にまた半角スペースを空け -executeMethod と記述し、そのあとに続けて Jenkins から実行する UnityEditor 内にあるクラスとメソッドを指定します。
また名前空間を含んでいる場合には、そちらも指定する必要があります。

　ここで指定した内容を Jenkins はジョブを実行したときに起動します。
例えば、Unity 内に用意したビルド用のメソッドを実行することで、Unity を立ち上げることなく、Jenkins 上でビルド作業を行うことが可能になります。

　この例であれば -executeMethod BuildScript.Build です。BuildScript クラスの Build メソッドを指定しています。(名前空間はないので書いていません)
これらはどちらも static です。

　これ以降は、バージョンの指定、Define Symbols の設定なども追記することで、指定可能です。
上記の例であれば、-buildVersion "1.0.3" と追加されているので、このバージョン情報を使ってビルドが作成されます。

　ジョブを作成すると、ダッシュボードにジョブが追加されます。

ビルド実行

　Unity が起動している場合には終了してください。
起動している状態で Jenkins のビルドを実行するとエラーが発生します。

========== OUTPUTTING STACK TRACE ==================

0x00007FF9D2D3FB4C (KERNELBASE) RaiseException
0x00007FF92E07AB45 (Unity) EditorMonoConsole::LogToConsoleImplementation
0x00007FF92E07B80A (Unity) EditorMonoConsole::LogToConsoleImplementation
0x00007FF92ED2C3BD (Unity) DebugStringToFilePostprocessedStacktrace
0x00007FF92ED2B758 (Unity) DebugStringToFile
0x00007FF92E182026 (Unity) HandleProjectAlreadyOpenInAnotherInstance
0x00007FF92E183F5E (Unity) Application::InitializeProject
0x00007FF92E78BD05 (Unity) UnityMain
0x00007FF6193F2FBA (Unity) __scrt_common_main_seh
0x00007FF9D418259D (KERNEL32) BaseThreadInitThunk
0x00007FF9D552AF38 (ntdll) RtlUserThreadStart

========== END OF STACKTRACE ===========

A crash has been intercepted by the crash handler. For call stack and other details, see the latest crash report generated in:
 * C:/Windows/TEMP/Unity/Editor/Crashes
Shut down.
FATAL: Unity3d command line execution failed with status 255
Build step 'Invoke Unity3d Editor' marked build as failure
Finished: FAILURE

　ビルドを行うと、ビルドの成否が表示されます。
対象のビルドを選択してコンソール出力を選択すると、ビルド時のログ(エラーなども)が確認できます。

　ビルドに成功すると、ローカル PC の指定したフォルダ内に APK ファイルと Addressables 用のビルドが作成されます。

　今回の場合 BuildScript で指定している Unity プロジェクトと同じ階層内にある output フォルダ内にファイルが作成されます。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

CI ツールによるビルド作業の効率化①　Jenkins - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school