最近公司在做移動端的項目,自然而然的需要搭建打包的環境。本來計划用Jenkins的,但是發現在gitlab上創建完項目后,提示去配置pipeline,於是決定用gitlab去嘗試下,畢竟我覺得Jenkins的配置過於復雜了。
gitlab-runner
在gitlab中,gitlab-runner相當於Jenkins中的slave的概念,所以首先需要給項目配置一個runner。gitlab-runner分為三種:Shared Runner、Group Runner、Specific Runner。其中:
- Shared Runner相當於全局的runner,所有的項目都可以使用。
- Group Runner相當於給一個分組設置runner,因此,分組中所有的項目都可以使用。
- Specific Runner顧名思義,就是項目特有的runner。只有這一個項目才能使用。
個人建議使用Group Runner,你可以根據不同種類的項目,創建不同的分組,比如:Android、IOS、服務端等,然后針對每個分組創建對應的Group Runner,這樣相互之間不會有影響,同時又不需要為每個工程單獨創建runner。
安裝gitlab-runner
需要在你的打包機器上安裝gitlab-runner,在不同的平台上,安裝gitlab-runner的方式不一致,可以參考官方文檔:https://docs.gitlab.com/runner/install/。這里以mac為例:
# 下載文件
$ sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-amd64
# 配置權限
sudo chmod +x /usr/local/bin/gitlab-runner
# 啟動gitlab runner
gitlab-runner install
gitlab-runner start
注冊gitlab-runner
[root@app3 ~]# sudo gitlab-runner register
Runtime platform arch=amd64 os=linux pid=6324 revision=1b659122 version=12.8.0
Running in system-mode.
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
http://192.168.4.194/
Please enter the gitlab-ci token for this runner:
rbLy6bwsNbTuzD_6Bma4
Please enter the gitlab-ci description for this runner:
[app3]: testandroid
Please enter the gitlab-ci tags for this runner (comma separated):
testandroid
Registering runner... succeeded runner=rbLy6bws
Please enter the executor: parallels, docker-ssh+machine, custom, docker-ssh, shell, ssh, virtualbox, docker+machine, kubernetes, docker:
docker
Please enter the default Docker image (e.g. ruby:2.6):
jangrewe/gitlab-ci-android
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!
執行上面的命令,就能將gitlab-runner注冊到gitlab中,需要說明下執行命令時輸入的幾個參數,其中gitlab-ci coordinator URL和gitlab-ci token可以從項目(Group需要master權限)的Settings—>CI/CD—>Runners中查看,如下圖所示:
gitlab-ci description是對runner的描述,根據情況填寫即可。
gitlab-ci tags 是runner的標簽,在后面的配置文件中會用到。
enter the executor是配置runner使用的執行器,可以是shell,如果你需要執行shell腳本的話。我們這里使用的是docker,使用了一個包含Android環境的容器:jangrewe/gitlab-ci-android。
另外,需要注意,在gitlab所在服務器的/etc/gitlab-runner/config.toml配置文件中也可以對gitlab-runner的注冊信息進行修改。
重啟gitlab-runner
需要注意的是,往gitlab注冊一個新的runner之后,需要將gitlab-runner進行重啟,這樣,注冊的runner才能生效。我在操作的時候,因為沒有重啟,花了好多時間解決出現的問題。其實只要重啟即可解決。
檢查gitlab-runner的狀態
配置好之后,可以在項目的settings—>CI/CD中查看新增的runner是否是running狀態,如下圖所示:
配置Android工程
runner配置好后,接下來的工作就是配置Android項目,只需要在工程目錄下創建.gitlab-ci.yml配置文件,然后往里面填充你想要實現的步驟即可,有點類似Jenkins中的pipeline腳本。不過,感覺gitlab ci的配置更加簡單一些。我項目中的配置文件如下所示:
image: gitlab-ci-android:V2 # 用來編譯 android 項目的鏡像
variables:
GRADLE_OPTS: "-Dorg.gradle.daemon=false" # 禁用 gradle 守護進程
before_script:
# 配置 gradle 的緩存目錄
- export GRADLE_USER_HOME=/cache/.gradle
# 獲取權限
- chmod +x ./gradlew
- chmod +x ./update-version-code.sh
stages:
- build
# 提交代碼自動編譯
build:
stage: build
only:
- master
script:
- ./gradlew assembleDebug
tags:
- android
# 構建測試包
qa:
stage: build
only:
- qa
script:
- ./gradlew assembleDebug
- sh -x /cache/deploy-android.sh
artifacts:
paths:
- app/build/outputs/apk/debug/
tags:
- android
上面配置的大致意思是:當開發往qa分支提交代碼時,會觸發構建測試包,打包完成后,會將包上傳到一個文件服務器上,方便下載安裝。
最后上一個gitlab的效果圖:
總結
整體來看,是不是挺簡單的,大家可以直接在gitlab上玩ci/cd,大大降低了成本。所以如果大家現在還沒有將CI/CD做起來的,大家可以考慮直接用gitlab來玩。