Jenkins+gradle+git部署

感謝博友分享，這邊記錄下https://blog.csdn.net/jiankeufo/article/details/78228334

 

 

我的密碼7789cc2b62114e9da9fb78b0aa3cb0c8   賬號  admin

安裝

上來就是干的，首先到Jenkins的官網下載https://jenkins.io，點擊Download Jenkins按鈕會彈出兩個版本選擇：LTS Release（長期支持版本），Weekly Release（每周更新版本）。首先說一下這兩個版本，個人覺得和MIUI的更新類似，一個開發版本一個穩定版，大家可以自行選擇，功能上幾乎沒區別。點擊尖角號會彈出操作系統，可以選擇對應的操作系統安裝，也可以直接下載2.xx.x.war包然后放在Tomcat（下文會詳細介紹Tomcat一些功能）的webapps目錄，新建Jenkins文件夾再放入。

我選擇的是Windows安裝版的，首先安裝版和war版我都嘗試過，功能是沒區別的，主要的區別在於目錄上，安裝版指定安裝目錄以后幾乎所有的東西都會在對應的文件夾下生成，比如Jobs（即存放工程目錄），不會在其他磁盤再生成多余的文件夾，而war版放在Tomcat目錄下以后，用瀏覽器打開，所有的東西會在C盤生成.Jenkins文件夾。我自己是有一些強迫症的，喜歡目錄整潔，不生成多余文件夾的。還有一個理由就是安裝版可以不依賴Tomcat，即使本機沒有安裝Tomcat，安裝版安裝完成后依然可以用本機ip:port啟動。大家可以自行選擇喜歡的版本。

由於安裝部分比較簡單，就不上圖了。

插件

1.進入管理插件

接下來就要說說，Jenkins最強大的部分之一了，那就是插件。Jenkins提供了非常多的插件，幾乎你想要的插件全有，前提是你能找的到~官網提供了插件搜索功能，選擇Plugins頁就可以各種搜索了。

重點來了（敲黑板，啪啪啪~）：首次進入，首先要輸入一個密鑰來進入Jenkins，接下來...接下來...上圖

setup.png

一般選擇第一項即可，會自動安裝推薦的插件，注意：這里並不是所有插件都能安裝成功，有的安裝失敗也不影響，所有的安裝完進行下一步就可以了。

But，有時候點擊以后會發生下面的情況

setup_error.png

怎么點擊Retry按鈕依然是錯誤，這時候不要慌張，咱們選擇第一張圖中的第二項，進行自己選擇，這里系統推薦的插件默認也是選中的，直接點安裝即可。But，個別情況依然會出現上圖的錯誤頁面，那么解決辦法就是：進入自行選擇頁面，清空選項即所有都不選，然后點安裝按鈕，進入下一頁。

下一頁就是創建用戶頁面，這里建議創建用戶，下面提供了Continue as admin按鈕也可進入主頁，但是后期想創建用戶還是很麻煩的，所以建議創建用戶。

創建好用戶，就可以進入到主頁了~選擇系統管理->管理插件->可選插件來開始安裝我們需要的插件。

2.插件列表

注意：列表中為主要插件，而Jenkins的插件是有依賴關系的，安裝一個插件可能要先安裝它依賴的插件，否則會安裝失敗。在可選插件勾選列表中的插件即可，依賴插件會自動下載，是不是很棒。

• Git plugin
• Gradle Plugin
• Email Extension Plugin
• description setter plugin
• build-name-setter
• user build vars plugin
• Post-Build Script Plug-in
• Branch API Plugin
• SSH plugin
• Scriptler
• Dynamic Parameter Plug-in
• Git Parameter Plug-In

  配置

  插件安裝完畢，我們就可以來配置Jenkins了，打包又離我們近了一步。

1.Global Tool Configuration

在系統管理選項中找到Global Tool Configuration進入，如果上面的插件安裝成功，在這里會看到三個板塊，如圖

Global_Tool_Configuration.png

分別是JDK，Git，Gradle板塊，分別配置這三個的路徑。

• JDK：別名=任意，JAVA_HOME=JDK目錄
• Git：別名=任意， Path to Git executable=Git安裝目錄\bin\git.exe
• Gradle：別名=任意，GRADLE_HOME=Gradle下載目錄\Gradle\gradle-2.xx
  Gradle盡量配置多個，因為項目的gradle版本可能不一樣，所以需要選擇不同的Gradle版本進行編譯

這個Gradle的目錄，可以是Android Studio默認下載的Gradle目錄，在用戶目錄的.gradle\wrapper\dists文件夾下，但是目錄不是很整潔；也可以到http://www.androiddevtools.cn找到gradle資源處下載常用的gradle版本，放到一個指定的文件夾，然后配置路徑即可，目錄比較整潔。

2.全局屬性

在這里最好配置一下全局屬性，這里先說一個，就是配置Android SDK目錄，在打包是有可能會出現ANDROID_HOME not found的情況，所以在系統管理->系統設置->全局屬性版塊勾選上Environment variables選項，然后添加

android_home.png

記得更改值內的路徑為本機sdk目錄。

注意：這里的鍵需要和本機環境變量內的Android SDK目錄的鍵一致

打包

1.創建項目

距離開始打包又近了一步，接下來就開始創建新項目了，點擊首頁的新建，進入下圖界面

create.png

給自己的項目起個名字，然后選擇構建一個自由風格的軟件項目，點擊OK按鈕，進入項目的配置界面。

2.項目配置

直接選擇源碼管理tab或者向下滾動找到源碼管理，如圖；

source_manage.png

選中Git選項，會出現上圖的界面，配置Git項目的URL，我測試用的是Github項目，並且傳輸協議選擇的是HTTP，需要選擇Credentials選項，選擇通行證，第一次需要點擊Add添加通行證，如圖：

credentials.png

Kind種類選擇默認的Username with password，然后在Username和Pasword處分別輸入Git賬戶的用戶名和密碼，然后滾動到下方點擊Add，然后在Credentials中選擇我們剛才添加的通行證。

接着滾動到構建Tab，點擊添加構建步驟，然后選擇Invoke Gradle script，如圖：

build.png

然后配置構建時的Gradle版本，和需要執行的任務，如圖：

build1.png

這個Tasks是先clean工程，然后打包所有渠道的Release版本，這是Gradle的命令，不多說了。然后點擊保存按鈕，馬上就可以打包了。

3.開始構建

點擊保存后，進入項目界面，如圖：

project.png

點擊左側菜單欄的立即構建，開始構建項目，這時候Build History版塊會出現構建任務列表，點擊進入可以查看構建詳情頁，如圖

project_build.png

又很多菜單可以選擇來查看狀態，點擊Console Output來查看構建輸出的日志，所有的信息都會顯示，日志最后輸出Finished: SUCCESS即構建成功。

成功之后，返回項目地址就可以點擊工作空間，在app的build目錄下面查看apk生成情況。

以上就是Jenkins打包最簡單的配置，我知道大家想要的不止這些，更精彩的還在后面。

定制想要的功能

1.參數化構建

在我們打包的時候，我們大多時候不想只是簡簡單單打一個版本的包，我們想通過配置一下參數，來滿足一些需求，比如根據渠道打不同版本的包、根據Tag打不同的包等，下面就來說一下Jenkins參數化構建。

在我們項目中需要配置的選項有：版本（Release 或 Debug），版本號，渠道包，根據Tag打包。另外我們還需要加上打包途徑，AS打包還是Jenkins打的包，還要加一個時間戳。所有的參數列出來了，下面就配置Jenkins的參數化構建吧~

在Jenkins項目主頁選擇配置，進入配置頁，在General tab將參數化構建過程選中，如圖：

General.png

接下來就可以添加參數了，下面我先列出參數表格：

參數名	參數類型	參數值列表
BUILD_TYPE	Choice	Release or Debug
IS_JENKINS	Choice	true
PRODUCT_FLAVORS	Choice	Xiaomi 、Wandoujia等
BUILD_TIME	Dynamic Parameter	2016-12-21-11-11
APP_VERSION	Choice	1.0.0、1.0.1等
GIT_TAG	Git Parameter	tag1.0.0等

下面直接放我的配置截圖：

build_type.png

product_flavor.png

app_version.png

is_jenkins.png

build_time.png

git_tag.png

配置完參數還不算完，我們要在下方構建時候引用，首先找到構建標簽處，將Tasks屬性值修改為：

clean assemble${PRODUCT_FLAVORS}${BUILD_TYPE} --stacktrace --debug

其中${PRODUCT_FLAVORS}和&{BUILD_TYPE}分別對應上面的參數名。配置如圖：

build2.png

看了圖大家肯定留意到了紅色框內的選項而且很好奇吧，這個選項是APP_VERSION、IS_JENKINS、BUILD_TIME需要用到的，因為這三個參數需要注入到Android項目中的配置一樣，而紅色框中的這個選項可以幫我們侵入到gradle.properties文件中替換值，並且build.gradle文件能夠直接引用gradle.properties文件中的屬性，所以起到了侵入的效果。下面分別是我的gradle.properties和主項目的build.gradle文件全代碼：

1. //gradle.properties
2.  
3. # Project-wide Gradle settings.
4. # IDE (e.g. Android Studio) users:
5. # Gradle settings configured through the IDE *will override*
6. # any settings specified in this file.
7. # For more details on how to configure your build environment visit
8. # http://www.gradle.org/docs/current/userguide/build_environment.html
9. # Specifies the JVM arguments used for the daemon process.
10. # The setting is particularly useful for tweaking memory settings.org.gradle.jvmargs=-Xmx1536m
11. # When configured, Gradle will run in incubating parallel mode.
12. # This option should only be used with decoupled projects. More details, visit
13. #http://www.gradle.org/docs/current/userguide/multi_project_builds.html
14. #sec:decoupled_projects
15. #org.gradle.parallel=true
16. APP_VERSION=1.0.1
17. IS_JENKINS=true
18. BUILD_TIME=''
19.  
20. //build.gradle
21.  
22. apply plugin: 'com.android.application'
23. def getDate() {
24. def date = new Date()
25. def formattedDate = date.format('yyyy-MM-dd-HH-mm')
26. return formattedDate
27. }
28. def verCode = 14
29. android {
30. compileSdkVersion 25
31. buildToolsVersion "25.0.0"
32. defaultConfig {
33. applicationId "com.zyyoona7.autobuildtest"
34. minSdkVersion 15
35. targetSdkVersion 23
36. testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
37. multiDexEnabled true
38. versionCode verCode
39. versionName APP_VERSION
40. }
41. signingConfigs {
42. signingConfig {
43. //由於本地打包使用的是本機上的KeyStore
44. //而Jenkins打包用的是服務器上的KeyStore
45. //兩個路徑不一樣
46. if("true".equals(IS_JENKINS)){
47. storeFile file("服務器上KeyStore的路徑")
48. }else {
49. storeFile file(STORE_FILE_PATH)
50. }
51. keyAlias KEY_ALIAS
52. keyPassword KEY_PASSWORD
53. storePassword STORE_FILE_PASSWORD
54. }
55. }
56. buildTypes {
57. release {
58. minifyEnabled true
59. zipAlignEnabled true
60. shrinkResources true
61. proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
62. signingConfig signingConfigs.signingConfig
63. }
64. debug { }
65. }
66. dexOptions {
67. javaMaxHeapSize "2g"
68. }
69. //渠道Flavors
70. productFlavors {
71. wandoujia {
72. manifestPlaceholders = [UMENG_CHANNEL_VALUE: "wandoujia"]
73. }
74. xiaomi {
75. manifestPlaceholders = [UMENG_CHANNEL_VALUE: "xiaomi"]
76. }
77. }
78. //修改生成的apk名字及輸出文件夾
79. applicationVariants.all { variant ->
80. variant.outputs.each { output ->
81. //新名字
82. def newName
83. //時間戳
84. def timeNow
85. //輸出文件夾
86. def outDirectory
87. //是否為Jenkins打包，輸出路徑不同
88. if ("true".equals(IS_JENKINS)) {
89. //Jenkins打包輸出到服務器路徑
90. timeNow = BUILD_TIME
91. //BUILD_PATH為服務器輸出路徑
92. outDirectory = BUILD_PATH
93. //AutoBuildTest-v1.0.1-xiaomi-release.apk
94. newName = 'AutoBuildTest-v' + APP_VERSION + '-' + variant.productFlavors[0].name + '-' + variant.buildType.name + '.apk'
95. } else {
96. //本機打包輸出在本機路徑
97. timeNow = getDate()
98. outDirectory = output.outputFile.getParent()
99. if ('debug'.equals(variant.buildType.name)) {
100. newName = "AutoBuildTest-v${APP_VERSION}-debug.apk"
101. } else {
102. //AutoBuildTest-v1.0.1-xiaomi-release.apk
103. newName = 'AutoBuildTest-v' + APP_VERSION + '-' + variant.productFlavors[0].name + '-' + variant.buildType.name + '.apk'
104. }
105. }
106. output.outputFile = new File(outDirectory+'/'+timeNow, newName)
107. }
108. }
109. }
110.  
111. dependencies {
112. compile fileTree(dir: 'libs', include: ['*.jar'])
113. androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
114. exclude group: 'com.android.support', module: 'support-annotations'
115. })
116. compile 'com.android.support:appcompat-v7:25.0.0'
117. testCompile 'junit:junit:4.12'
118. }

這樣在Jenkins打包的時候上面三個參數就會隨着選擇變化而變化了。

GIT_TAG參數使用配置，只需在源碼管理處的Branch引用改為$GIT_TAG引用參數名，如圖：

git_tag_use.png

參數配置完畢，看一下主頁面的效果吧，現在立即構建選項變成了 Build with Parameters，完成圖：

build_with_parameters.png

提示：

• 如果選中了GIT_TAG中的任意版本都無法取消選中，只能刷新；
• 還有使用GIT_TAG時最好選擇tag版本大於等於支持Jenkins打包的版本，因為之前版本代碼中沒加需要侵入的屬性

2.按時打包

由於篇幅原因加上這個功能我沒用在項目中，所以請參考使用Jenkins搭建iOS/Android持續集成打包平台的配置構建觸發器部分。

3.構建命名

每次構建的時候，Build History模塊顯示是這樣的，如圖：

build_history.png

每次構建都只顯示數字（#xx），這樣很不好看，我們想要它顯示更多的信息怎么辦呢？比如加入構建者姓名、構建的app版本、構建的類型等。請看下圖：

set_build_name.png

配置完以后再次打包，變成了這個樣子，如圖：

build_history1.png

是不是很Nice，當然大家還可以根據需求自行發揮~

4.Tomcat配置下載地址

打完包放在服務器上，我們得配置一下下載環境才能下載，首先是Tomcat的安裝，這里對Tomcat安裝就不做詳細的介紹了，如果不熟悉的請自行谷歌或百度，下面內容需基於Tomcat環境進行，我的Tomcat版本為8.0+。

這里說一下如何使用Tomcat配置下載地址，首先進入Tomcat目錄下的conf文件夾，然后打開server.xml文件在最后添加如圖代碼：

erver.png

1. <!-- docBase為絕對路徑即板寸apk文件的文件夾，path為相對地址即在地址欄訪問的地址-->
2. <Context reloadable="true" docBase="C://android/downloadApk" crossContext="true" path="/downloadApk"/>

添加完這句話以后啟動Tomcat服務，打開瀏覽器輸入IP:Port/downloadApk，就可以訪問了點擊你想要的文件下載吧。

5.二維碼下載

二維碼下載功能，現在網上大多數的做法是通過蒲公英或者fir.im來生成二維碼，這兩個都是內測平台，我體驗過蒲公英，需要將文件傳到蒲公英網站然后他們生成二維碼返回，傳到別處總感覺怪怪的，於是我決定自己生成二維碼然后放在下載地址的文件夾中，通過鏈接顯示。

首先要在電腦上安裝python環境，請看http://www.cnblogs.com/yuanzm/p/4089856.html和(Python問題一)python 安裝PIL (Python Imaging Library )來進行安裝，如果已經安裝繼續往下看。生成二維碼我用了qrcode這個庫，感謝大神的分享，這個庫如何使用就不介紹了，我只說一下Jenkins如何執行python。

添加python的環境變量到Jenkins的環境變量中，文章前面有提到過，在系統管理->系統設置中，如圖添加python環境變量：

python.png

注意：鍵名需要和電腦上系統環境變量內的鍵名保持一致。

然后打開項目配置頁面，在構建版塊點擊添加構建步驟，如圖：

add_build.png

在編輯框內輸入qrcode項目的使用命令

python_build.png

注意：下載地址需要自己拼接，生成路徑也需要自己拼接。

這樣每次打包后都會在生成apk的文件夾內生成一個對應的二維碼。掃一掃就可以下載啦~~~

6.構建后操作

構建完成后，我希望將下載地址和二維碼放在Build History的版塊中，方便下載，那么我們就來設置一下，打開項目配置頁，如圖操作：

build_after.png

在Description輸入框內添加

1. <!-- 需替換鏈接地址 -->
2.  <br>
3. <a href="http://192.168.1.88:8088/downloadApk/${BUILD_TIME}/AutoBuildTest-v${APP_VERSION}-${PRODUCT_FLAVOR}-${BUILD_TYPE}.apk">下載連接</a>

7.郵件通知

打完包，我想通知需要下載的人怎么辦？發郵件~~Jenkins自帶了郵件功能，但是不太好用，所以我選擇了Email Extension Plugin這個插件來實現發郵件功能（已經在插件列表中）。進入系統管理->系統設置頁面，如圖：

mail.png

郵件格式：

1. [Jenkins構建通知]$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!
2.  
3. (郵件由Jenkins自動發出，請勿回復~) <br>
4. 項目名稱：$PROJECT_NAME <br>
5. 構建編號：$BUILD_NUMBER <br>
6. 構建狀態：$BUILD_STATUS <br>
7. 觸發原因：${CAUSE} <br>
8. 構建地址： <A HREF="${BUILD_URL}">${BUILD_URL}</A><br>
9. 構建輸出日志： <a href="http://192.168.1.201:8090/job/${PROJECT_NAME}/${BUILD_NUMBER}/console">http://192.168.1.201:8090/job/${PROJECT_NAME}/${BUILD_NUMBER}/console</a><br>
10. 下載地址： <a href="http://192.168.1.88:8088/downloadApk">http://192.168.1.88:8088/downloadApk</a><br><br>
11. 二維碼下載： <br>
12. 最近修改： <br>${CHANGES, showPaths=false, format="%a：\"%m\"<br>", pathFormat="\n\t- %p"}

注意：請自行修改對應的地址，關於最近修改請參照http://stackoverflow.com/questions/7773010/how-to-include-git-changelog-in-jenkins-emails

最終的效果圖是介個樣子的：

mail1.png

遇到的錯誤

1.AAPT err(Facade for 26390200):build-tools/23.0.1/aapt: /lib/libc.so.6: version `GLIBC_2.11' not found /23.0.1/aapt)

在將Jenkins部署到linux服務器的時候出現了這個錯誤，lib/libc.so.6是linux系統的c庫，由於我們公司服務器的linux系統太老，導致最高支持GLIBC_2.5，雖然可以通過升級內核來解決，但是有風險，所以最后決定還是部署到了Windows服務器上面。所以在部署到Linux服務器上面之前先檢查你的Linux系統所支持的GLIBC_2.xx的版本，Android Build-Tools 25.0.0的需要GLIBC_2.14。

2.local.properties：sdk.dir not found or ANDROID_HOME not found

不好意思，因為沒及時記錄所以這個錯誤我只記了大概，而且配置完以后，想出現這個錯誤竟然沒復現，所以只能看個大概了。這個錯誤主要是配置Android SDK路徑為ANDROID_HOME環境變量沒有配置。Windows上面配置一下環境變量；名字ANDROID_HOME：值為Android SDK路徑。還有一種方法，配置Jenkins的環境變量名字和值和上面一樣，添加到系統管理->系統設置->全局屬性下面有一個Environment variables 勾上，然后添加環境變量即可

總結

Jenkins打包並不難，最難的地方就是安裝插件，由於公司網絡不太給力導致安裝插件至少半天，坑啊~~~

如果在Linux系統上和Mac上使用Jenkins的化設置起來幾乎無差別，只是需要的文件格式大同小異而已。

由於篇幅比較多，希望大家看完多多反饋，有什么問題也可以留言。

參考

使用Jenkins搭建iOS/Android持續集成打包平台
利用Jenkins玩轉Android自動打包發包