12.03 在 Jenkins 上顯示打包二維碼

前言

在Jenkins上顯示二維碼,是為了每次打完包之後都能方便的用手機下載,不必再使用數據線安裝。
本文涉及以下內容

架設Web服務器(https)Jenkins的history顯示圖片Mac安裝Homebrew和Python3本地生成二維碼shell生成manifest.plist微信掃碼跳轉Jenkins的Job之間傳遞變量

準備

在Jenkins上顯示二維碼的思路是修改BuildDescription並放置二維碼圖片的鏈接
因此我們需要準備以下內容

項目備註Web服務器用來存放打出來的安裝包,可以參照 這裡 部署二維碼將安裝包的鏈接轉換為二維碼圖片build-name-setterJenkins插件,修改BuildName(新版本為Build Name and Description Setter,集成了修改BuildDescription的功能)

動手

一、在Jenkins上顯示二維碼圖片

1. 安裝Jenkins插件

進入Jenkins工作臺系統管理>插件管理>可選插件>過濾>build-name-setter,勾選對應插件直接安裝返回工作臺首頁,選擇一個Build工程>配置可以看到構建環境處多了一個Set Build Name的選項,即插件安裝成功

2. 配置Set Build Name插件

查看Jekins的環境變量參數,我們可以看到

BUILD_NUMBER
The current build number, such as "153"
BUILD_DISPLAY_NAME
The display name of the current build, which is something like "#153" by default.
Set Build Name就是修改這個BUILD_DISPLAY_NAME,默認為#${BUILD_NUMBER}Jenkins的默認安全設置,會把所有的輸入都當成純文本,為了使圖片鏈接生效,需要更改一下系統管理>全局安全配置>標記格式器,將純文本選項改為Safe HTML,保存設置點擊Set Build Name的高級,會出現Build Description的設置,可以在這裡寫入一個圖片的鏈接

安裝完畢後brew -v驗證是否安裝成功

$ brew -v
Homebrew 2.1.2
Homebrew/homebrew-core (git revision 48bc; last commit 2019-05-13)

如果出現

-bash: brew: command not found

可能是環境變量沒有配置好,配置環境變量並更新使其生效

2. 安裝Python 3

安裝完Homebrew之後,通過命令安裝Python 3,Homebrew中的Python默認是Python 3,因此:

$ brew install python

安裝完畢後,輸入python3和pip3驗證是否安裝成功

$ python3
Python 3.7.3 (default, Mar 27 2019, 09:23:15)
[Clang 10.0.1 (clang-1001.0.46.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> exit()

$ pip3

Usage:
pip3 <command> [options]

Commands:
install Install packages.
···
/<command>


3. 安裝MyQR

$ pip3 install myqr

驗證安裝是否成功

$ myqr -h

4. MyQR生成二維碼

MyQR的常用參數:

myqr Words
[-v {1,2,3,...,40}]
[-l {L,M,Q,H}]
[-n output-filename]
[-d output-directory]
[-p picture_file]
[-c]
[-con contrast]
[-bri brightness]
生成二維碼,會在當前目錄下生成指定的二維碼


myqr 'hello word'

可以通過-n和-d來設置生成文件名和路徑

$ myqr 'hello word' -n hellow.png -d ../path/

常用參數說明:

-v 控制邊長,範圍是1至40,數字越大邊長越大;

-l 控制糾錯水平,範圍是L、M、Q、H,從左到右依次升高。

-n 控制文件名,格式可以是 .jpg, .png ,.bmp ,.gif ;

-d 控制位置。

-p 用來將QR二維碼圖像與一張同目錄下的圖片相結合,產生一張黑白圖片。

-c 可以使產生的圖片由黑白變為彩色的。

-con 用以調節圖片的對比度,1.0 表示原始圖片,更小的值表示更低對比度,更大反之。默認為1.0。

-bri 用來調節圖片的亮度,其餘用法和取值與 -con 相同。

缺點是不能識別中文,優點是一行代碼即可生成,比較方便,字符範圍:

數字 0 到 9



大小寫的英文字母

常用英文標點符號和空格

· , . : ; + - * / \\ ~ ! @ # $ % ^ & ` ' = < > [ ] ( ) ? _ { } | and (space)

三、規範安裝包鏈接地址

1. 修改Apache默認站點目錄

為了方便管理和處理權限問題,我們需要修改Apache的默認站點路徑

先創建一個新的Web路徑

$ cd /Users/{$username}/
$ mkdir WebSites
$ cd WebSites
$ pwd
/Users/{$username}/WebSites
修改Apache的httpd.conf配置 $ sudo vim /private/etc/apache2/httpd.conf 找到DocumentRoot配置 DocumentRoot "/Library/WebServer/Documents" <directory> 修改為 DocumentRoot "/Users/{$username}/WebSites" <directory>/<directory>修改Apache的httpd-ssl.conf配置 $ sudo vim /private/etc/apache2/extra/httpd-ssl.conf 找到DocumentRoot配置 DocumentRoot "/Library/WebServer/Documents" 修改為 DocumentRoot "/Users/{$username}/WebSites"在新的Web路徑下創建一個主頁 $ cd /Users/{$username}/WebSites $ vim index.html 插入內容

Hello New World!

重啟Apache服務 $ sudo apachectl restart驗證修改
訪問服務器IP或域名進行驗證,http://和https://都需驗證
頁面出現Hello New World!證明修改成功

2. 創建安裝包存放路徑

$ mkdir app
$ cd app


$ mkdir and
$ cd and
$ mkdir qrimg
···

創建文件路徑如下

|-- app //總目錄
|-- and //存放Android相關文件
| |-- apk //存放apk
| |-- qrimg //存放對應的二維碼圖片
|-- ios //存放iOS相關文件
|-- icon //存放plist中對應的icon
|-- ipa //存放ipa
|-- plist //存放ipa對應plist文件
|-- ssl //存放SSL證書
|-- qrimg //存放對應的二維碼圖片

四、修改腳本路徑並生成二維碼

現在我們需要將打包腳本中生成的文件存儲在對應的目錄下

1. Android腳本修改

Android腳本比較好修改,只需在Jenkins生成apk時,將生成路徑修改為上面存放的路徑/Users/{$username}/WebSites/app/apk,具體打包腳本不便貼出,這裡將相關變量和修改的代碼貼一下

# parameters always
curlTime=`date +%Y%m%d%H%M%S`
outputpath=/Users/{username}/Desktop/package/Android_package/apk
packagename=Test


platform=android
webApk=/Users/{username}/WebSites/app/and/apk

cp $outputpath/$packagename.apk $webApk/$packagename\\_$curlTime.apk
apkUrl='http://主機地址/app/and/apk/'$packagename\\_$curlTime'.apk'
myqr $apkUrl -n andqr_${JOB_NAME}${BUILD_NUMBER}.png -d /Users/{$username}/WebSites/app/and/qrimg
qrUrl='http://主機地址/app/and/qrimg/andqr_${JOB_NAME}${BUILD_NUMBER}.png'

此時,我們得到了Android包的下載地址的二維碼,然後把這個地址放在Set Build Name>高級>Build Description裡即可


再Build時,就可以在構建歷史中看到對應的二維碼了


2. iOS腳本修改

iOS腳本修改的原理和Android類似,不同的是ipa不像apk一樣可以直接安裝,需要通過OTA的方式安裝(詳見這篇文章),因此我們要生成ipa對應的plist文件和對應的二維碼

相關變量

# parameters always
curlTime=`date +%Y%m%d%H%M%S`
packagename=Zeus
ipaName=$packagename\\_$curlTime
exportPath=/Users/xt/Desktop/package/iOS_package/ipa
ipaPath=/Users/xt/WebSites/app/ios/ipa

#生成的ipa拷到指定位置
cp $exportPath/Unity-iPhone.ipa $ipaPath

#manifest.plilst需要的參數
ipaUrl='https://主機地址/app/ios/ipa/'$ipaName'.ipa'
disImg='https://主機地址/app/ios/icon/57.png'
fullImg='https://主機地址/app/ios/icon/512.png'
bundleId=com.xxx.yyy
bundleVersion=0.0.1
displayName=Zeus
根據上面參數生成manifest.plist

cd /Users/xt/WebSites/app/ios/plist
cat << EOF > ${ipaName}.plist


<plist>
<dict>
items
<array>


<dict>
assets
<array>
<dict>
kind
<string>software-package/<string>
url
<string>${ipaUrl}/<string>
/<dict>
<dict>
kind
<string>display-image/<string>
url
<string>${disImg}/<string>
/<dict>
<dict>
kind
<string>full-size-image/<string>
url
<string>${fullImg}/<string>
/<dict>
/<array>
metadata
<dict>
bundle-identifier
<string>${bundleId}/<string>
bundle-version
<string>${bundleVersion}/<string>
kind
<string>software/<string>
title
<string>${displayName}/<string>
/<dict>
/<dict>
/<array>
/<dict>
/<plist>
EOF
將plist對應的超鏈接生成二維碼

plistUrl="itms-services://?action=download-manifest&url=https://主機地址/app/ios/plist/${ipaName}.plist"
myqr $plistUrl -n iosqr_${JOB_NAME}${BUILD_NUMBER.png -d /Users/xt/WebSites/app/ios/qrimg

把這個地址放在Set Build Name>高級>Build Description裡即可

再把SSL證書做一個下載二維碼,放在JOB說明中,方便第一次的安裝下載

$ cd /Users/xt/WebSites/app/ios/ssl
$ myqr http://主機地址/app/ios/ssl/ip211.crt



在實際應用過程中,大多數人的掃碼工具還都是微信,但是微信內置瀏覽器的解析方式和其他瀏覽器不一樣,我們還需要對這種情況進行處理。

判斷是否是微信瀏覽器
微信官方推薦JS做法

var ua = navigator.userAgent.toLowerCase();
  var isWeixin = ua.indexOf('micromessenger') != -1;
  if (isWeixin) {
   return true;
  }else{
   return false;
  }

完整的HTML示例如下:




ooooo





可參考上面生成plist的方式,生成對應的apk,ssl證書和plist對應的html文件,然後將html的地址生成二維碼。

補充

這樣做完後單個JOB命令過長,可將不同任務拆分成不同的JOB,此時需要注意在不同JOB之間傳遞變量

# 將之前的內容刪除
if [ -f "${WORKSPACE}/tempParams.txt" ];then
rm "${WORKSPACE}/tempParams.txt"
else
echo "File not exist"
fi

# 變量寫入文件
echo bundleID="${bundleId}" >> "${WORKSPACE}/tempParams.txt"
echo ipaUrl="${bundleId}" >> "${WORKSPACE}/tempParams.txt"
····


其他JOB開始時讀取變量

source "${WORKSPACE}/tempParams.txt""