Jenkins 打包Unity APK

新建一個Unity 工程，新增編輯器打包指令碼

編輯器指令碼 APKBuild.cs 
編輯狀態下呼叫 APKBuild中 Build 方法，執行打包， 
測試成功開始編寫 批處理指令碼 Unity.bat 通過批處理指令碼呼叫 APKBuild中 Build 方法 執行打包 
執行批處理打包成功開始在Jenkins新建專案

APKBuild.cs 程式碼如下

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEditor;


public
 
 class APKBuild : Editor
{

    [MenuItem("Tool/APKBuild")]
    public static void Build()
    {
        BuildTarget buildTarget = BuildTarget.Android;
        // 切換到 Android 平臺
        EditorUserBuildSettings.SwitchActiveBuildTarget(buildTarget);

        // keystore 路徑, G:\keystore\one.keystore
        PlayerSettings.Android.keystoreName = "G:\\keystore\\one.keystore"
 
;
        // one.keystore 密碼
        PlayerSettings.Android.keystorePass = "123456";

        // one.keystore 別名
        PlayerSettings.Android.keyaliasName = "bieming1";
        // 別名密碼
        PlayerSettings.Android.keyaliasPass = "123456";

        List<string> levels = new List<string>();
        foreach
 
 (EditorBuildSettingsScene scene in EditorBuildSettings.scenes)
        {
            if (!scene.enabled) continue;
            // 獲取有效的 Scene
            levels.Add(scene.path);
        }

        // 打包出 APK 名
        string apkName = string.Format("./{0}.apk", "Test");
        // 執行打包
        string res = BuildPipeline.BuildPlayer(levels.ToArray(), apkName, buildTarget, BuildOptions.None);

        AssetDatabase.Refresh();
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43

在編輯器下可以呼叫 Build() 方法執行打包 APK

新建批處理指令碼 Unity.bat

H:\Unity\Unity\Editor\Unity.exe -projectPath G:\MyProject\AndroidSDKUnityDemo\AndroidSDKDemo -quit -batchmode -executeMethod APKBuild.Build -logFile build.log

• 1

引數介紹

H:\Unity\Unity\Editor\Unity.exe 為Unity 安裝執行檔案

-projectPath 執行Unity遊戲工程

G:\MyProject\AndroidSDKUnityDemo\AndroidSDKDemo 為Unity 工程目錄 Assets 上一層目錄

-quit 表示執行結束自動退出

-executeMethod 表示執行 編輯器方法

APKBuild.Build  APKBuild 為編輯器指令碼 APKBuild.cs ， 中APKBuild.cs Build 函式名

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

最終 Unity.bat 指令碼

@echo off  

echo 正在生成APK檔案...  

REM H:\Unity\Unity\Editor\Unity.exe -projectPath G:\MyProject\AndroidSDKUnityDemo\AndroidSDKDemo -quit -batchmode -executeMethod APKBuild.Build -logFile build.log

%1 -projectPath %2 -quit -batchmode -executeMethod APKBuild.Build -logFile build.log

echo APK檔案生成完畢!  
pause 

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

上面 %1 %2 我通過在執行批處理指令碼的時候將引數傳遞進來

將 Unity.bat 放在 Unity 專案根目錄(和 Assets 同級) 

將Unity 工程上傳到 SVN伺服器

開始Jenkins 
新建一個新工程 

下一步彈出配置介面 

原始碼管理

中選擇 SubVersion 配置SVN 路徑和使用者名稱密碼 

點選 Add 新增一個使用者名稱和密碼 

Check -out Strategy 中配置每次構建時執行的 SVN update命令(每次構建時會將SVN 中最新的專案更新到 Jenkins 的工作空間WORKSPACE)

如我本地的Jenkins 工作空間位置，Jenkins新建的專案都會放在 workspace 下

C:\Users\Dev\.jenkins\workspace\

• 1

構建中選擇 Windows 批處理， 
 
第一行列印一個 HelloWorld 
第二行執行 Unity.bat 後邊兩個引數 分別傳遞給批處理中 %1，%2

%WORKSPACE% 是Jenkins 中可用的環境變數，表示該專案在Jnekins 中的目錄位置
本專案在Jenkins 為 TestDemo則 %WORKSPACE% 在我本地為 C:\Users\Dev\.jenkins\workspace\TestDemo

• 1
• 2

配置完成儲存，執行構建（構建時要將 Unity 關掉） 

可以檢視日誌 

等待構建 
構建完成後開啟工作空間，發現目錄下生成一個 Test.apk 表示 APK 生成成功 

下面來看下我的 Unity 工程和 Jenkins 工程的關係

Unity Demo工程目錄如下 

Unity Demo工程上傳到 SVN 伺服器

在 Jenkins 中新建TestDemo專案，在 TestDemo配置中 新增 Demo工程上傳的 SVN 伺服器路徑

Jenkins 在構建構建時會從 SVN 伺服器將 Demo 工程 CheckOut 到 Jenkins 的工作空間中 TestDemo 專案下 

開啟 TestDmeo 資料夾，我已經執行過構建了， Jenkins 已經從 SVN 上更新了最新的專案到 工作空間中 

然後我在執行 Unity.bat 時，將 %WORKSPACE% 在我本地為(C:\Users\Dev.jenkins\workspace\TestDemo)傳遞了進去，即執行的 打包工程是Jenkins 工作空間的這個工程

每次修改Unity Demo 工程，將修改提交到 SVN，然後再執行 Jenkins 構建

mac部署

1. 下載Jenkins war安裝包
   Jenkins下載地址，下載war安裝包
   

   mac jenkins war安裝包.png

2. 安裝Tomcat

要注意的是jdk版本,選擇jdk8，不然執行jenkins會報錯：jdk下載地址

報錯日誌：Stack trace
java.lang.AssertionError: InstanceIdentity is missing its singleton
org.jenkinsci.main.modules.instance_identity.InstanceIdentity.get(InstanceIdentity.java:133)
at org.jenkinsci.main.modules.instance_identity.InstanceIdentityRSAProvider.getKeyPair(InstanceIdentityRSAProvider.java:23)
at jenkins.model.identity.InstanceIdentityProvider$KeyTypes.get(InstanceIdentityProvider.java:161)
at jenkins.model.identity.InstanceIdentityProvider$KeyTypes.getKeyPair(InstanceIdentityProvider.java:210)
at jenkins.model.identity.IdentityRootAction.getUrlName(IdentityRootAction.java:42)
at jenkins.model.Jenkins.getDynamic(Jenkins.java:3635)
...
Caused: javax.servlet.ServletException
at org.kohsuke.stapler.Stapler.tryInvoke(Stapler.java:765)
at org.kohsuke.stapler.Stapler.invoke(Stapler.java:845)
at org.kohsuke.stapler.Stapler.invoke(Stapler.java:649)
at org.kohsuke.stapler.Stapler.service(Stapler.java:238)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:742)

如果mac下已經安裝多版本JDK，可以按照Mac下多版本JDK安裝來設定／切換使用版本

Tomcat安裝包選擇tar.gz版： Tomcat下載地址

安裝Tomcat完成後：

1. 將下載的Jenkins war包，放入之前Tomcat資料夾下/webapps資料夾中。

2. 載入成功會讓輸入密碼，密碼在圖中紅色的路徑檔案裡面

   
   密碼路徑，copy.png

3. 建議點選推薦安裝 Install suggests plugins

目錄：

1. credentials使用kind: Username and password
2. credentials使用kind: SSH Username private key
   2.1 SSH基礎;什麼是ssh?什麼是公鑰？什麼是私鑰？什麼是數字簽名、數字證書？
   2.2 配置SSH Username private key credentials的5個步驟
   2.3 git ssh正確情況截圖
   2.4 報錯情況處理：code 128:Permission denied (publickey)

git配置（GitHub）

git配置主要是設定credentials，常用的有2種方式：

1. kind: Username and password

如何驗證這種方式是否有效呢？

1. 新建 自由風格的軟體專案

   
   構建自由風格的軟體專案.png

2. 只需配置原始碼管理這一項，注意URL要HTTPS（在github上建立一個repositories 或者使用 測試使用：github UnityJenkins工程地址），credentials選擇剛剛建立的Username and password，儲存。
   

   git credentials-userName and password.png

3. 立即構建，若成功，在~/.jenkins/workspace中可以看到clone到的工程；若失敗，檢查賬號密碼。

   
   Jenkins git clone成功到workspace.png

2. kind: SSH Username private key

2.1 SSH基礎

使用SSH這種方式，需要明白什麼是ssh?什麼是公鑰？什麼是私鑰？什麼是數字簽名、數字證書？

如果都明白，可以跳過下面3個連結：

2.2 配置SSH Username private key credentials的5個步驟

接下來生成一個SSH Username private key credentials

這個GitHub官方ssh連結 說明的非常詳細，能看懂就參照這個連結一步步做

大概分為以下幾步：

1. Checking for existing SSH keys，檢查SSH keys是否已存在，如果id_dsa（私鑰）、id_dsa.pub（公鑰）已存在，跳過2、3步驟，若不存在則生成
2. Generating a new SSH key and adding it to the ssh-agent，生成新的SSH key，並新增到ssh-agent。這時候按第一步檢查，id_dsa（私鑰）、id_dsa.pub（公鑰）已存在則成功。
3. Jenkins配置credentials，將id_dsa（私鑰）的內容copy到SSH Username private key credentials中（private key選擇enter directly），Username、ID隨意。

2.3 git ssh正確情況截圖

2.4 報錯情況處理：code 128:Permission denied (publickey)

若出現code 128:Permission denied (publickey)的報錯,說明ssh key credentials沒有配置對。

按照上面5個步驟檢查一遍。用第四步檢查GitHub上是否配置成功，若成功，檢查id_dsa（私鑰）的內容copy過程有沒有遺漏，private key是否正確。

構建失敗日誌： ERROR: Error cloning remote repo 'origin'
hudson.plugins.git.GitException: Command  returned status code 128:
stdout: 
stderr: Permission denied (publickey).
fatal: Could not read from remote repository.

解決完code 128:Permission denied (publickey)報錯，按1.1的方式驗證是否能成功clone工程。
區別是URL要SSH，例如[email protected]:GeWenL/UnityJenkins.git，如“git ssh正確情況截圖.png”所示。