Blue Ocean 是 Jenkins 推出的一套新的 UI，對比經典 UI 更具有現代化氣息。2017 年 4 月 James Dumay 在部落格上正式推出了 Blue Ocean 1.0。
相容 Blue Ocean 的 Jenkins 版本只需要安裝外掛即可使用，對於已經在使用 Pipeline 構建的 Jenkins Job 基本可以無縫切換到新 UI。
以構建 Android 專案為例，學習如何使用 Jenkins Blue Ocean 與宣告式 Pipeline，示例專案可以在 GitHub 上檢視：
部署 Jenkins
在 Linux 上使用 docker-compose 通過專案中的編排檔案快速部署 Jenkins。
修改 .env 中的 ANDROID_HOME 引數為 Android SKD 路徑，然後執行 docker-compose up -d 啟動容器，通過 http://ip:8080 訪問 Jenkins。
可以根據需要修改 jenkins_home 的掛載路徑，由於示例專案的 Jenkinsfile 是直接使用 master 節點作為構建節點，因此 Windows 系統的 Android SDK 應該是無法使用的(Mac 不確定，沒硬體)。Windows/Mac 下構建需要以新增 Jenkins Agent 的方式執行，並在 Jenkinsfile 中需要修改構建使用的 Agent 和相應構建命令，相應的環境變數也需要配置。
關於如何在 CLI 下管理 Android SDK 可以閱讀官方文件： developer.android.com/studio/comm…
Fork 示例專案或者 Clone 後簽入到可訪問的 Git 倉庫中，按嚮導操作新增新 Pipeline 即可。示例專案分為 master beta prod 三個分支，分別對應開發環境、測試環境、生產環境，僅作參考。
Docker Compose
...
environment:
- ANDROID_HOME=/opt/android-linux-sdk
- ANDROID_SDK_HOME=/var/jenkins_home/tmp/android
- GRADLE_USER_HOME=/var/jenkins_home/tools/gradle
...
複製程式碼ANDROID_HOME 是 Android SDK 的路徑，ANDROID_SDK_HOME 是 Android 專案構建中 SDK 產生的臨時檔案路徑，GRADLE_USER_HOME 是 Gradle 的路徑。
ANDROID_SDK_HOME 與 GRADLE_USER_HOME 預設都是在使用者目錄下，通過宣告環境變數配置到 /var/jenkins_home 路徑下，也可以在 Jenkins 中配置環境變數的方式實現。
...
volumes:
- /etc/localtime:/etc/localtime:ro
- /var/run/docker.sock:/var/run/docker.sock:ro
- jenkins_home:/var/jenkins_home
- ${ANDROID_HOME}:/opt/android-linux-sdk
...
複製程式碼初始化 Jenkins 密碼可以通過 docker-compose logs jenkins-blueocean 檢視日誌得到。部署 Jenkins 完成後按嚮導完成初始化，安裝必要的外掛。
在 Jenkins 外掛管理中安裝 Blue Ocean Plugin 與 Android Signing Plugin 外掛。
注：掛載 /var/run/docker.sock 的原因是使用型別為 Docker 或 Docker File 的 Agent，Jenkins 需要可以訪問 Docker Daemon。
準備工作
由於 Jenkinsfile 與專案程式碼是存放在同一專案下，因此需要將敏感資訊與專案分離，交由 Jenkins 管理儲存。然後在構建過程中讀取 Jenkins 配置資訊，避免敏感資訊洩漏。
對於 Android 專案，最重要的是 APK 簽名檔案，通過使用外掛 Android Signing Plugin 來保護簽名檔案及金鑰。
使用 Credentials Plugin 外掛保護專案中第三方 API 的 Secret Key，避免在專案程式碼中洩漏.
Credentials Plugin
在 Credentials 中新增 ID 為 BETA_SECRET_KEY 與 PROD_SECRET_KEY 的 Secret Text，內容為需要保護的 API Secret Key。
Android Sign Plugin
Android Sign Plugin 依賴 Credentials Plugin，因為 Credentials Plugin 只支援 PKCS#12 格式的證書，所以先需要將生成好的 JKS 證書轉換為 PKCS#12 格式：
keytool -importkeystore -srckeystore tomczhen.jks -srcstoretype JKS -deststoretype PKCS12 -destkeystore tomczhen.p12
複製程式碼新增型別為 credential，選擇上傳證書檔案，將 PKCS#12 證書上傳到並配置好 ID，本專案中使用了 ANDROID_SIGN_KEY_STORE 作為 ID。
Jenkinsfile
Pipeline 功能在之前的 Jenkins 版本中已經存在了，Jenkins Pipeline 分有兩種：Declarative Pipeline 與 Scripted Pipeline 。
兩者的區別是 Declarative Pipeline 必須以 pipeline 塊包含：
pipeline {
...
}
複製程式碼而 Scripted Pipeline 則以 node 塊包含：
node {
...
}
複製程式碼Declarative Pipeline 使用宣告式的寫法，也支援引入 Scripted Pipeline 程式碼：
pipeline {
...
stages {
...
stage('Script Example) {
steps {
script {
if (isUnix()) {
sh './gradlew clean assembleBetaDebug'
} else {
bat 'gradlew clean assembleBetaDebug'
}
}
}
...
}
...
}
複製程式碼雖然功能和靈活度上並沒有 Scripted Pipeline 強，但是簡單易懂，可以快速上手使用。本文的的指令碼程式碼都是 Declarative Pipeline 型別的。
引數
使用 parameters 塊來宣告引數化，不過由於 Blue Ocean 與 Declarative Pipeline 都是新生事物，所以當前支援的引數型別有限，需要等待社群擴充套件或者以 Scripted Pipeline 實現複雜需求。
pipeline {
...
parameters {
string(
name: 'PARAM_STRING',
defaultValue: 'String',
description: 'String Parameter'
)
choice(
name: 'PARAM_CHOICE',
choices: '1st\n2nd\n3rd',
description: 'Choice Parameter'
)
booleanParam(
name: 'PARAM_CHECKBOX',
defaultValue: true,
description: 'Checkbox Parameter'
)
text(
name: 'PARAM_TEXT'
defaultValue: 'a-long-text',
description: 'Text Parameter'
)
}
stages {
...
stage('Parameters Example') {
steps {
echo "Output Parameters"
echo "PARAM_STRING=${params.PARAM_STRING}"
echo "PARAM_CHOICE=${params.PARAM_CHOICE}"
echo "PARAM_CHECKBOX=${params.PARAM_CHECKBOX}"
echo "PARAM_TEXT=${params.PARAM_TEXT}"
}
}
...
}
...
}
複製程式碼環境變數
可以通過 environment 宣告環境變數，在 pipeline 頂層宣告的變數全域性有效，而在 stage 中宣告的變數僅在 stage 中有效。
使用 withEnv 可以讓變數僅在執行 step 時有效，可以根據需要選擇宣告的方法。
pipeline {
...
environment {
CC = 'clang'
}
stages {
...
stage('withEnv Example') {
steps {
echo 'Run Step With Env'
withEnv(['ENV_FIRST=true', 'ENV_SECOND=sqlite']) {
echo "ENV_FIRST=${env.ENV_FIRST}"
echo "ENV_SECOND=${env.ENV_SECOND}"
}
}
}
stage('Environment Example') {
environment {
SECRET_KEY = credentials('a-secret-text-id')
}
steps {
sh 'printenv'
}
}
}
...
}
複製程式碼Credentials
有兩種方式獲取 Credential 的值，一種是使用 credentials()，在環境變數說明中已經有使用過，還可以使用 withCredentials 的方式獲取：
pipeline {
...
stages {
...
stage("Build Beta APK") {
steps {
echo 'Building Beta APK...'
withCredentials([string(credentialsId: 'BETA_SECRET_KEY', variable: 'SECRET_KEY')]) {
script {
if (isUnix()) {
sh './gradlew clean assembleBetaDebug'
} else {
bat 'gradlew clean assembleBetaDebug'
}
}
}
...
}
...
}
複製程式碼與 withEnv 一樣，SECRET_KEY 只在 withCredentials 塊內部有效。
Android Sign
Android Sign Plugin 的使用比較簡單，配置好引數即可：
pipeline {
...
stages {
...
stage("Sign APK") {
steps {
echo 'Sign APK'
signAndroidApks(
keyStoreId: "ANDROID_SIGN_KEY_STORE",
keyAlias: "tomczhen",
apksToSign: "**/*-prod-release-unsigned.apk",
archiveSignedApks: false,
archiveUnsignedApks: false
)
}
}
...
}
...
}
複製程式碼Android Gradle
參考文件： Configure Build Variants
Build Config
在 Jenkinsfile 中宣告的環境變數，可以在 gradle 指令碼中獲取變數值：
android {
...
defaultConfig {
...
buildConfigField "String", "SECRET_KEY", String.format("\"%s\"", System.getenv("SECRET_KEY") ?: "Develop Secret Key")
}
...
}
複製程式碼然後在 Android 專案程式碼中使用 BuildConfig 類來使用：
BuildConfig.SECRET_KEY
複製程式碼Product Flavors
使用 Product Flavor 來對應不同的構建分支：
android {
...
productFlavors {
dev {
...
applicationIdSuffix ".dev"
versionNameSuffix "-dev"
resValue("string", "version_name_suffix", getVersionNameSuffix())
}
beta {
...
applicationIdSuffix ".beta"
versionNameSuffix "-beta"
resValue("string", "version_name_suffix", getVersionNameSuffix())
}
prod {
...
resValue("string", "version_name_suffix", "")
}
}
...
}
複製程式碼ToDo
- 觸發構建
- 測試步驟
- 構建物收集