[TOC]
經常在開發的時候,測試/產品/運營等人員會來要求安裝一下軟體,這時候不得不停下手中的事情來打包安裝,但終歸不是長久之計:
- 自己開發時被經常打斷思路;
- 停下來手頭的工作來打包,每次怎麼也得浪費個幾分鐘,長期下來不划算;
- 開發中的程式碼經常不是穩定或者未經過自測的程式碼,冒然給人安裝總是容易發生問題,徒增bug;
P.S. jenkins會去gitlab倉庫中讀取最新的分支程式碼到本地,具體地址也就是其環境變數作為一個 '懶人' ,這種重複性的工作腫麼能每次都自己動手呢,另外最好再有個地方能提供穩定分支程式碼的安裝包供人下載安裝,省得有人說不會安裝apk ==!... 話說前公司就提供有自動打包功能,以前不覺得有什麼,等到沒有的時候才發覺它的好...無奈,只能自己動手搭一套;
WORKSPACE
指代的位置;
基於: 系統: mac 10.12.4(Sierra) Jenkins: 2.46.1 Git: 2.10.0 Python: 3.x
Jenkins的基本使用
安裝執行Jenkins
- 到 官網 下載軟體,應該是一個
jenkins.war
單檔案; - 執行:
// 方式1: 假如系統中安裝有Tomcat,就把它當做普通的war包放置到 webapps/ 下執行即可;
// 方式2: (假設 jenkins.war 放置在 ~/Downloads/ 目錄下)
cd ~/Downloads/
nohup java -jar jenkins.war & // 後臺執行jenkins.war程式,預設使用8080埠
// 指定埠
--httpPort=8080 // 用來設定jenkins執行時的web埠,避免衝突
複製程式碼
- 安裝執行成功後在瀏覽器中開啟
localhost:8080
(埠號請按需修改),第一次會要求輸入賬號密碼,jenkins
提供了一個初始密碼,可以根據頁面提示在檔案initialAdminPassword
中獲取:
sudo cat /Users/***/initialAdminPassword // 提示路徑可能不同,根據頁面提示修改
複製程式碼
- 初始化後就會彈出新增賬號的介面,按需設定一個新的賬號密碼,也可以後續在 Manage Users 中進行建立或修改;
- 登入成功後會有個安裝外掛提示頁面,選擇
Install suggested plugins
:
後續也可在 jenkins首頁 -
Manage Jenkins
-Manage Plugins
中安裝外掛,主要是Gradle Plugin
Android Signing Plugin
Git Parameter Plug-In
GitHub Authentication plugin
Gitlab Authentication plugin
Git plugin
等
- 安裝完重啟就可以在首頁新增任務
New Item
,新增完成後會在右側顯示已新增的 job 列表:
初始化配置
開始打包釋出Android應用前需要進行如下環境的設定:Android/Git/Gradle/Python等
指定ANDROID_HOME全域性變數
==! 不知道咋回事,沒有識別到我配置在
~/.bash_profile
中的ANDROID_HOME環境變數,最後折騰了好久才發現要在jenkins中手動指定一個
在 Manage Jenkins
- Configure System
- Global properties
勾選 Environment variables
,並新增一個:
Name : ANDROID_HOME
Value : /Users/***/Applications/AndroidSDK
複製程式碼
配置JDK/Git/Gradle
在 Manage Jenkins
- global tool configuration
中按需選擇工具 , name
隨意指定,其他的參考下圖:
// 配置JDK主目錄
name: MAC_JDK
path: /Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home
// 配置Git執行路徑
name: Default
path: /usr/bin/git
// 配置Gradle主目錄
name: gradle3.5
path: /Users/lynxz/.sdkman/candidates/gradle/current/bin
// 注意: 在 `gradle /current/bin/bin`中需存在 `gradle` 可執行檔案;
// 備註: 我之前是使用 `sdkman` 來安裝的 `gradle` ,所以路徑比較奇怪
curl -s https://get.sdkman.io | bash
sdk install gradle 3.5
複製程式碼
建立和配置job
- 在jenkins首頁左側導航欄中點選
new item
, 輸入名稱, 選擇Freestyle project
,點選ok
按鈕即可; - 建立完成後,在首頁右側的 Job 列表中選擇剛才建立的job,然後選擇
Configure
進行配置; - 在
General
中按需輸入project name
和Description
; 另外,這個tab頁面中比較常用的還有引數化設定(This project is parameterized
), 後續會講到; - 在
Source Code Management
中指定版本管理型別/倉庫地址/認證資訊等; - 在
Build
中選擇Invoke Gradle Script
,在Gradle Version
下拉選單中選擇自定義的本機Gradle版本;並在Tasks
中輸入打包命令:
// 預設未做多渠道多版本配置時,打包release型別的命令:
clean assembleRelease --stacktrace --debug
複製程式碼
如果有需要將 general
標籤也中定義的變數注入到專案中讓 gradle
指令碼使用,則請勾選 Pass job parameters as Gradle properties
,則gradle指令碼中用到的同名自定義變數就會使用jenkins中指定的值;
引數化構建
有時候需要在構建的時候進行一些定製化操作,比如指定編譯的程式碼分支,增加打包版本說明等,又或者專案中使用了私有倉庫,而倉庫的登入賬號名(如mavenUser
)以及密碼(mavenPassword
)儲存於 gradle.properties
(不同步到gitlab倉庫中),這時就需要新增引數,並將該引數注入到Android專案中了,以便gradle指令碼能獲取到正確的值,具體操作如下:
- 在job頁面的
Configure
-General
皮膚中勾選This project is parameterized
; - 在
Add Parameter
下拉選單中就可以選擇對應的型別變數
注意: 若引數需要注入到Android專案構建指令碼中,則需要勾選 configure
- Build
- Pass job parameters as Gradle properties
;
3. 比如選擇新增一個 String Parameter
Choice Parameter
,用於指定要打包的版本:
圖中指定的三個choice是我在Android專案 app/build.gradle
中定義過的,用於後續的打包命令:
android{
buildTypes {
release {
signingConfig signingConfigs.release
}
//不能以"test"開頭
tstEnv {
debuggable true
signingConfig signingConfigs.release
}
debug {
versionNameSuffix "-dev"
debuggable true
signingConfig signingConfigs.release
}
}
}
複製程式碼
上面指定的 choice parameter
型別引數 buildTypes
便可用在 Build
命令中:
簽名
還沒去研究過jenkins簽名外掛,一般直接在Android專案中配置好指令碼即可:
- 將簽名檔案
*.jks
放置於app/
目錄下; - 在
app/build.gradle
中配置簽名引數,這樣jenkins打包出來的apk就是簽名過的:
android{
signingConfigs {
release {
keyAlias '***'
keyPassword '***'
storeFile file('*.jks')
storePassword '***'
}
}
buildTypes {
release {
signingConfig signingConfigs.release
}
debug {
signingConfig signingConfigs.release
}
}
}
複製程式碼
P.S. 不過總覺得這樣直接公開簽名檔案到倉庫中不太好,在打包伺服器上進行控制會更合適點,畢竟知曉的人更少,這個後續再研究,先佔個位;
獲取當前使用者的名稱等資訊
- 需要安裝外掛
user build vars plugin
,可在外掛列表中直接獲取安裝 或者到 這裡 下載外掛包; - 安裝後等待jenkins重啟,並找到
job
-configure
-Build Environment
-Set jenkins user build variables
,勾選此項後才生效; - 在 shell 中便可像jenkins自帶的變數那樣使用,如
echo "$BUILD_USER"
:
外掛可用的變數名 | 變數描述 |
---|---|
BUILD_USER | Full name (first name + last name) |
BUILD_USER_FIRST_NAME | First name |
BUILD_USER_LAST_NAME | Last name |
BUILD_USER_ID | Jenkins user ID |
BUILD_USER_EMAIL | Email address |
Build History 定製
預設的job構建歷史命名( 如 #35 Apr 27, 2017 11:15 AM
)不容易理解記憶,我們可以自定義,加入構建者姓名,版本等資訊;
定製包括"build name" 和 "build description" 兩部分的定製,效果如下
構建名稱定製
- 下載 Build Name Setter Plugin 外掛;
- 手動安裝:
manage jenkins
-manage plugins
-Advanced
在upload plugin
中選擇剛才下載的外掛,提交後重啟jenkins即可; - 選擇一個 job 進入
Configure
-Build Environment
,就會多出一個Set Build Name
複選項,勾選後即可定製;
構建描述定製
-
安裝外掛
description setter plugin
(可以在jenkins的manage plugins
中找到); -
重啟jenkins後,進入 job 的
Configure
-post-build Actions
,選擇Add post-build action
-set build description
即可定製; -
為了顯示蒲公英的二維碼圖片,需要先在
manage jenkins
-Configure global security
,找到Markup Formatter
,將預設的plain text
改為safe html
; -
在 job -
configure
-post-build actions
-set build description
中就可以輸入html標籤了,比如我設定了:
// 這裡的${pgyerNotes}是我在general中新增的引數
<p>${pgyerNotes}</p><br/>![](https://static.pgyer.com/app/qrcode/Cb6T)<br/><a href='https://www.pgyer.com/Cb6T'>Download Directly</a>
複製程式碼
構建完成後打包記錄並顯示在 job 首頁面,便於下載
- 進入 job -
Configure
-Post-Build Actions
- 在
Add post-build action
列表中選擇Archive the artifacts
輸入要存檔的檔案路徑,可使用萬用字元,比如我輸入的是app/build/outputs/apk/Sb*.apk
,就會在job專案首頁看到存檔記錄,可以直接下載; 注意:這裡不能使用${WORKSPACE}
等變數,貌似就是直接以當前工作空間為根目錄的;
使用shell上傳apk到蒲公英
請首先到 蒲公英 上註冊賬號,並認證,若不認證則上傳失敗;
蒲公英上傳檔案介面
蒲公英的key值可在 賬戶設定
- API資訊
中檢視到
由於我是mac系統,因此在 Job - Configure
- Build
- Add build step
列表中選擇 Execute shell
,執行shell指令碼
P.S. 若是對shell不熟悉,可參考 教程
另外,由於我在專案中根據版本號(vesionName)重新命名了生成的apk,因此需要在shell指令碼中提取版本號以便獲得apk全稱,進而上傳蒲公英
# build -> Add build step -> Execute shell
pgyerApiKey="******"
pgyerUKey=="******"
echo "獲取apk版本號..."
# ${WORKSPACE} 是jenkins提供的環境變數,表示當前專案跟目錄路徑
# 下面的命令是獲取 app/build.gradle 的第17行內容,然後按照雙引號進行切換,提取第2部分內容,即上面圖示中的 1.1.4
versionName=`sed -n '17p' ${WORKSPACE}/app/build.gradle | cut -d \" -f 2`
echo "獲取apk所在路徑..."
# _360 是專案中定義了多渠道,但由於之前在 Build - Task 中設定的打包命令,直接指定了渠道號,因此這裡也直接固定寫好就可以;
apkAbsPath="${WORKSPACE}/app/build/outputs/apk/SonicMoving_${buildTypes}_[_360]_v${versionName}.apk"
echo "上傳apk到蒲公英進行釋出..."
response=$(curl -F "file=@${apkAbsPath}" -F "uKey=${pgyerUKey}" -F "_api_key=${pgyerApiKey}" https://qiniu-storage.pgyer.com/apiv1/app/upload)
echo "上傳結束"
# 原本上傳結束後想要使用 jq 工具 (`brew install jq`) 對蒲公英上傳時返回的response進行json處理的,結果在電腦的shell中測試可行,但寫到這裡就一直不成功,無奈,只好放棄
# 提取蒲公英返回的json資料中的 appShortcutUrl 欄位值,可拼接成下載地址
#responseCode=$(echo -E "${response}" | jq .code)
#if [ $((responseCode)) == 0 ]
#then
# echo "上傳結束,處理返回相應..."
# appShortcutUrl=$(echo -E "${response}" | jq ".data.appShortcutUrl" | cut -d \" -f 2)
# apkOnlineUrl="https://www.pgyer.com/${appShortcutUrl}"
#else
# echo "上傳失敗,返回碼為: ${responseCode} ,具體請看日誌"
#fi
複製程式碼
使用python上傳apk到蒲公英
最早之前我也是嘗試直接使用python外掛的,操作如下:
- 安裝
Python Plugin
; - 在 job 的
Configure
-Build
中就會多一個選項Execute python script
;
import os
# 獲取jenkins變數 'BUILD_NUMBER'
print("build_number is ==> ",os.getenv("BUILD_NUMBER"))
複製程式碼
但是由於我是mac,系統中預設的python是2.7.x,而我又裝了其他版本的python,雖然在jenkins的全域性變數中指定了python版本,但實際執行的時候卻用的不是它,大致的錯誤如下:
可以發現jenkins把我們寫在python script
中的生成了一份位於 /var/.../*.py
的檔案,然後使用系統預設的 python
版本來執行,而我 mac 預設的python是python2.7.*,導致裡面寫的很多基於python3.x的程式碼出錯:
解決方案
使用python多版本問題的常用方法 virtualenv
,最後演變成通過shell來啟用版本隔離,然後手動呼叫python命令載入指令碼:
在 Build
- add build step
- execute shell
中寫入如下指令碼:
# 如果當前無指定的環境目錄存在,則建立,並指定python版本
if [ ! -d ".env" ]; then
virtualenv -p /usr/local/bin/python3 .env
fi
# 啟動virtualenv
source .env/bin/activate
echo "當前操作的使用者是 : $BUILD_USER "
#requestsLibName="requests"
#isInstallRequest=$(pip freeze | grep $requestsLibName)
#if [[ $isInstallRequest =~ "*requests*" ]];then
# pip install requests
#fi
# 安裝所需要的第三方庫,若已安裝,則不會重新安裝
pip install requests
# 執行指定路徑下的python指令碼
python3 ~/Desktop/upload.py
複製程式碼
上面shell指令碼中的 upload.py
內容如下(可考慮將其放在Android專案中,上傳gitlab):
#!/usr/local/bin/python3.5
# -*- coding: utf-8 -*-
'''
jenkins 打包線上程式碼生成apk後釋出到蒲公英
本指令碼路徑: ~/Desktop/upload.py
'''
import os
import io
import re
import requests
import json
WORKSPACE = os.getenv("WORKSPACE") # 獲取jenkins環境變數
userName = os.getenv("BUILD_USER") # 獲取使用者名稱
buildTypes = os.getenv("buildTypes") # 獲取使用者選擇的編譯版本
pgyerNotes = os.getenv("pgyerNotes") # 獲取使用者填寫的版本說明
# 重置預設編碼為utf8
import sys
default_encoding = 'utf-8'
if sys.getdefaultencoding() != default_encoding:
reload(sys)
sys.setdefaultencoding(default_encoding)
# 確認下當前python版本
print("當前編譯器版本: %s " % sys.version)
print("python編譯器詳細資訊: ", sys.version_info)
# 獲取版本號
# guild.gralde檔案所在路徑
buildGradleFilePath = "%s/app/build.gradle" % (WORKSPACE) # 指定檔案所在的路徑
print("build.gradle路徑是: ", buildGradleFilePath)
# 讀取build.gradle並獲取versionName值
with open(buildGradleFilePath, 'r', encoding='utf-8') as buildGradleFile:
line = buildGradleFile.readlines()[16:17][0] # 讀取第17行資料, 切片從0開始;
print("line 17 is .... ", line)
versionName = re.split(r'\"', line)[1]
print("版本號為: %s" % versionName)
# "獲取apk所在路徑..."
apkAbsPath = "%s/app/build/outputs/apk/SonicMoving_%s_[_360]_v%s.apk" % (WORKSPACE, buildTypes, versionName)
print("準備上傳apk到蒲公英進行釋出,apk所在路徑為: %s" % apkAbsPath)
# 上傳結束後發出請求通知服務端,進而由服務端傳送釘釘訊息
def notify_upload_result(msg):
headers = {'user-agent': 'jenkins_upload_pgyer'}
params = {'userName': userName, 'msg': msg} # 欄位中值為None的欄位不會被新增到url中
response = requests.get('http://btcserver.site:8080/WebHookServer_war', params=params, headers=headers)
#response = requests.get('http://localhost:8081', params=params, headers=headers)
print("通知webhook伺服器結果: ", response.text)
# 蒲公英賬號資訊
pgyerApiKey = "******"
pgyerUKey = "******"
# response=$(curl -F "file=@${apkAbsPath}" -F "uKey=${pgyerUKey}" -F "_api_key=${pgyerApiKey}" -F "updateDescription=${pgyerNotes}" https://qiniu-storage.pgyer.com/apiv1/app/upload | jq .)
# post請求中所需攜帶的資訊
data = {
'_api_key': pgyerApiKey,
'uKey': pgyerUKey,
'updateDescription': pgyerNotes
}
files = {'file': open(apkAbsPath, 'rb')}
uploadUrl = 'https://qiniu-storage.pgyer.com/apiv1/app/upload'
response = requests.post(uploadUrl, data=data, files=files)
print(response.status_code, response.text)
if response.status_code == 200:
print("上傳成功,通知webhook伺服器...")
notify_upload_result(response.text)
else:
print("上傳失敗,狀態碼為: %s" % (response.status_code))
複製程式碼
蒲公英發布成功後通知釘釘
參考 打通Gitlab與釘釘之間的通訊 這裡有兩種方式通知伺服器後臺:
- 使用蒲公英專案中自帶的webhook功能,但是這個通知無法具體得知是誰進行的這次打包釋出,並且若上傳蒲公英失敗的話也不會進行webhook通知,因此不太方便:
- 如上面python指令碼中寫那樣,在上傳返回後,主動呼叫伺服器介面,將response和jenkins相關資訊上傳,然後後臺有針對性的傳送訊息;
碰到的異常
1. Failed to connect to repository : Command "git ls-remote -h https://git.***.git HEAD" returned status code 143:
需要在倉庫中新增公鑰;
//獲取公鑰
ssh-keygen -t rsa -f ~/.ssh/id_rsa.pub
複製程式碼
測試時用的是 coding.net
, 因此在 coding.net
對應專案的 設定
- 部署公鑰
- 新建部署公鑰
將剛才輸出的公鑰貼上進去即可;
2. token-macro v1.5.1 is missing. To fix, install v1.5.1 or later
token-macro-plugin
到外掛管理頁面中搜尋 Token Macro Plugin
安裝即可;