Jenkins 持續整合使用教程

在路上。發表於2018-04-18

Jenkins

用 jenkins 有什麼好處

通過規範化來完成，簡單，繁瑣，浪費時間的重複工作
規範化工作，以免出現低階錯誤
實現隨時隨地任何人一鍵構建
......

安裝 jenkins

以 Mac 裝置為例（Windows 步驟類似），幫你一步一步搭建好 jenkins。jenkins 屬於 java 專案依賴於 java，需要先安裝 java jdk，具體安裝方式請自行百度。

安裝 jenkins 有常用的三種方式。

使用 pgk 安裝包安裝

在官網下載 pgk 安裝包，使用安裝器安裝，按照流程安裝即可。此安裝方式會在 Mac 系統裡建立一個名為 jenkins 使用者，jenkins 服務就部署在這個使用者下。

具體步驟如下圖所示：

此種方式不推薦。

使用 war 安裝

直接去官網下載 war 檔案，並 cd 到 jenkins.war 所在目錄，執行：

java -jar jenkins.war --httpPort=8080

war 包自帶 jetty 伺服器，以上命令會自動啟伺服器，並完成部署。

此種方式安裝，會在當前使用者的根路徑下建立 .jenkins 隱藏檔案，併產生多餘的配置檔案，需手動管理，且不方便解除安裝。

此種方式也不推薦。

使用 Homebrew 安裝

Homebrew 作為 macOS 下的包管理器使用起來異常的簡單快捷方便。安裝 Homebrew 之前, 首先安裝 Command Line Tools for Xcode，命令如下：

xcode-select --install

Homebrew 依賴 Command Line Tools for Xcode，Xcode 命令列工具包含在 Xcode 中，如果 mac 裝置已經安裝 Xcode,請忽略此步。

安裝完上面的編譯依賴之後，通過下面的程式碼完成 Homebrew 的安裝：

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

完成 Homebrew 安裝。

可通過以下命令檢視當前 Homebrew 管理的服務:

brew services list

使用 Hombrew 安裝 jenkins，執行以下命令：

brew install jenkins

此步，Homebrew 會下載並安裝自動完成所有依賴，包括 java。並會建立 ‘jenkins’ 命令。

同時，解除安裝 jenkins 的方式為:

brew uninstall jenkins

啟動 jenkins 服務的方式為：

brew services start jenkins

使用此種方式啟用 jenkins 服務支援後臺執行，可以關閉終端工具。

也可以使用 jenkins 命令來啟用 jenkins 服務。但此種方式不支援後臺執行，關閉命令列工具，服務自動關閉。

另，常用命令還有：

重啟 jenkins 服務的方式為：

brew services restart jenkins

停止 jenkins 服務的方式為：

brew services stop jenkins

通過此種方式安裝，不會在系統中產生垃圾檔案和多餘的配置檔案，所有的檔案都是用 Homebrew 來管理，並且方便解除安裝。

此種方式強烈推薦。

如安以上方式安裝後，localhost 打不開，可能的情況一般有：java jdk 未正確安裝或配置，8080埠被佔用，安裝路徑許可權不夠等等的問題，遇到這樣的問題最好的辦法是：解除安裝重灌。不同的安裝方式，解除安裝方式也會不同。具體可參看這個教程。

另，也有如下方式操作 Jenkins 服務

http://localhost:8080/exit //停止服務

http://localhost:8080/restart //重啟服務

http://localhost:8080/reload // 重新載入服務

配置 jenkins

建立使用者

完成 jenkins 安裝以後，在瀏覽器種開啟 localhost ，會進入配置 jenkins 頁面。

按照提示，找到/Users/Shared/Jenkins/Home/ 這個目錄下，開啟 initialAdminPassword 檔案，複製出密碼並填入，點選繼續，進入安裝外掛頁面。

建議選擇 Install suggested plugins。

等待外掛安裝完成後，jenkins 會重啟，等待重啟完成後，會進入建立使用者頁面。

填寫使用者資訊後，儲存即可。請務必記住使用者名稱和密碼資訊，否則重置使用者資訊非常麻煩。

安裝外掛

登入 http://localhost:8080 ，選擇“系統管理”——“管理外掛”,在“可選外掛”中選中“GitLab Plugin”、“Gitlab Hook Plugin”、“Xcode integration"等常用外掛，然後安裝。

安裝完成外掛後，就可以新建專案了!

其他常用外掛有：

Email Extension Plugin 該外掛用於替換 Jenkins 自帶的郵件傳送，更加的強大。

Git Plugin 該外掛允許使用GIT作為一個構建SCM(原始碼控制管理系統)。

Post build task 該外掛允許使用者依據構建日誌的輸出執行一個shell/批處理任務。

Ruby Plugin 該外掛允許使用者在構建指令碼中使用 Ruby。

Python Plugin 新增執行 Python 指令碼作為Hudson的構建步驟。

Gradle Plugin 該外掛允許Hudson呼叫Gradle構建指令碼作為主體構建的步驟。

FTP-Publisher Plugin 該外掛能上傳專案構件和整個目錄到一個FTP伺服器。

Extended Choice Parameter plugin 該外掛可以擴充套件引數化構建過程

Extended Choice Parameter Plug-In 該外掛可以擴充套件引數化構建過程

Dynamic Extended Choice Parameter Plug-In 該外掛可以擴充套件引數化構建過程

git parameter Plug-in 該外掛可以擴充套件引數化構建過程

fir-plugin 該外掛是 fir.im 分發平臺提供的 jenkins 外掛，用於上傳安裝包到 fir.im 平臺。此外掛安裝方式與上面的外掛安裝方式不同，具體安裝方式見文末。

新建專案

點選新建，在新建專案頁面輸入專案名稱，選擇“構建一個自由風格的軟體專案”，然後進入配置頁面

在原始碼管理中選擇 Git ,填寫倉庫地址

如出現紅色警告，說明 Jenkins 訪問不了 Git 倉庫，一般是因為沒有許可權導致。點選 Credentials 項的 Add ，在開啟的 Jenkins Credentails Provider:Jenkins 頁面，在 Username 和 Password 輸入 Git 倉庫的使用者名稱和密碼，完成新增。不必擔心使用者資訊外洩，Jenkins 服務和所有配置都儲存在本地。

還可以通過配置 Git SSH 的方式賦予 Jenkins 訪問 Git 倉庫的許可權，按此方法較為麻煩，具體步驟略。

在 Branches to build 中設定 Branch Specifier 要構建的分支，預設為 master。

在構建觸發器中設定構建自動化的觸發器。

其中 Build periodically，為定時 build，在日程表裡設定 build 時間，如設定 00 20 * * * 表示每天 20 點執行定時 build。

Poll SCM (poll source code management) 輪詢原始碼管理，表示在指定的時間點去輪詢 Git 倉庫，看是否有新的 commit，如有，則觸發構建。如設定 0/5 * * * * 表示每5分鐘輪詢一次。

完成此步驟後，剩餘的工作，皆可通過 Execute shell 指令碼來執行。不同型別專案執行指令碼不同。

指令碼構建

以構建 iOS 的 SellerPlatform 迷橙商家端專案上傳 fir.im 分發平臺為例完成建立。

第一步歸檔

archive.sh

`#! bin/bash
export LCALL=zhCN.GB2312; export LANG=zh_CN.GB2312
gitMessage=git log --pretty=format:"%s";
stringTag=${gitMessage%%】}; #%%[ 表示從右邊開始，刪除最後（最左邊）一個 [ 號及右邊的字元
debug="【Debug"; preRelase="【PreRelase"; relase="【Relase";
if [[ $stringTag != $debug && $stringTag != $preRelase && $stringTag != $relase ]] then exit 1 else echo "觸發非引數化構建暗號：$stringTag】" fi
echo ">>>>>>>>>>>>>>>>>>>開始構建專案，當前選擇構建型別：" + $BUILDTYPE echo ">>>>>>>>>>>>>>>>>>>當前 workspace " +$WORKSPACE
if [ $BUILDTYPE == "Release"]; then xcodebuild archive -workspace $WORKSPACE/SellerPlatform/SellerPlatform.xcworkspace -archivePath $WORKSPACE/build/SellerPlatform.xcarchive -sdk iphoneos -scheme SellerPlatform -configuration Release
else xcodebuild archive -workspace $WORKSPACE/SellerPlatform/SellerPlatform.xcworkspace -archivePath $WORKSPACE/build/SellerPlatform.xcarchive -sdk iphoneos -scheme SellerPlatform -configuration Debug
fi
echo ">>>>>>>>>>>>>>>>>>>構建完成"

以上指令碼實現的功能是：當在 git commit messge 裡包含指定的標記號，即可完成對應標記號的構建。把控制權延伸到 git commit 操作裡。

其中【Debug】代表打 debug 版本包，【PreRelase】代表打 preRelase 版本包，【Relase】代表打 relase 版本包。

首先，通過執行 git log --pretty=format:"%s" 命令，格式化輸出 git commit log, 通過 %%】* 操作，是要拿到最後標記號【Debug】或【PreRelase】或【Relase】，如果拿到對應的標記號，則完成對應方式的構建。

另，Jenkins 會為每個工程專案建立一個本地目錄空間，並提供了 $WORKSPACE 環境變數來直接訪問。

第二步簽名

signature.sh

echo "開始簽名"
xcodebuild -exportArchive -archivePath $WORKSPACE/build/SellerPlatform.xcarchive -exportPath $WORKSPACE/build -exportOptionsPlist $WORKSPACE/build/ExportOptions.plist -allowProvisioningUpdates
echo "ipa檔案已生成"
echo "開始上傳fir"

以上指令碼實現的功能是：根據第一步歸檔出來的projectName.xcarchive 完成簽名打包。

第三步上傳

首先，開啟終端，安裝 fir-clifir 的命令列工具，用於通過命令列上傳安裝包。需要先裝好 ruby 再執行

gem install fir-cli

上傳打 fir 命令

fir publish ${ipa_path} -T fir_token -c "${commit_msg}"

upload.sh

echo ">>>>>>>>>>>>>>>>>>>開始上傳到 fir" if [$BUILDTYPE == "Debug" ]; then
fir publish $WORKSPACE/build/SellerPlatform.ipa -T efa7a5559110764a5037c52d4599635f --password rose888 -c $CHANGELOG
elif [ $BUILDTYPE == "PreRelease" ]; then
fir publish $WORKSPACE/build/SellerPlatform.ipa -T 4f43ef4e28992358b511a76eb1c27d48 --password rose888 -c $CHANGELOG
else
fir publish $WORKSPACE/build/SellerPlatform.ipa -T 3a9a1a361fe52b8b0d5eb59c7d0bd808 --password rose888 -c $CHANGELOG
fi
echo ">>>>>>>>>>>>>>>>>>>上傳成功啦"

至此，就完成了持續整合的流程。

完成後建構，還可以通過 Email Extension Plugin 外掛，郵件通知到相關人員。還可以定製郵件內容。在郵件內容裡，還可以放置二維碼，方便下載安裝。

更進一步，引數化構建

引數化構建，顧名思義，就是可以指定構建引數，完成高度可定製化構建。

首先，需要安裝 git parameter Plug-in 外掛，然後專案配置頁面，在 General 中，選中‘引數化構建過程’，然後選擇 git parameter。如圖所示:

設定 name 為 git_branch，即為變數名，然後 Parameter type ,就是選擇 branch/tag/branch or tag 三種型別，在原始碼管理中 Branches to build 中設定 Branch Specifier 為 $git_branch 。即可完成自定義分支構建。

同樣，可以設定構建的版本型別。在構建的時候，進行選擇。在此不再贅述。