Jira自動化實踐：基于Jenkins實現需求與代碼基線關聯
作者：Lizeyang
JIRA是Atlassian公司出品的項目與事務跟蹤工具，被廣泛應用于缺陷跟蹤、客戶服務、需求收集、流程審批、任務跟蹤、項目跟蹤和敏捷管理等工作領域。
一. Jira簡介
中文官網：https://www.atlassian.com/zh/software/jira
1.1 Jira可以做什么?
規劃
創建項目，用戶需求和事務、規劃 Sprint 并跨團隊分配開發任務。
跟蹤
全面了解項目進度情況，安排整個團隊工作的優先級排序并進行討論。
二. 安裝部署
2.1 數據中心版本
https://www.atlassian.com/zh/software/jira/pricing?tab=data-center 試用
選擇歷史版本下載：
下載最新的LTS 長期支持版本：
選擇部署的環境：
開始下載Jira Software Server安裝程序：
2.2 安裝部署
- scp atlassian-jira-software-8.20.1-x64.bin root@192.168.1.200:/opt/
- ## 添加權限
- [root@zeyang-nuc-service opt]# chmod +x atlassian-jira-software-8.20.1-x64.bin
- ## 運行安裝程序
- [root@zeyang-nuc-service opt]# ./atlassian-jira-software-8.20.1-x64.bin
- Unpacking JRE ...
- Starting Installer ...
- This will install Jira Software 8.20.1 on your computer.
- OK [o, Enter], Cancel [c] ## 回車
- Click Next to continue, or Cancel to exit Setup.
- Choose the appropriate installation or upgrade option.
- Please choose one of the following:
- Express Install (use default settings) [1], Custom Install (recommended for advanced users) [2, Enter], Upgrade an existing Jira installation [3]
- ## 此處選擇自定義安裝， 輸入回車
- Select the folder where you would like Jira Software to be installed.
- Where should Jira Software be installed?
- [/opt/atlassian/jira]
- ## 選擇安裝目錄
- Default location for Jira Software data
- [/var/atlassian/application-data/jira]
- ## 選擇數據目錄
- Configure which ports Jira Software will use.
- Jira requires two TCP ports that are not being used by any other
- applications on this machine. The HTTP port is where you will access Jira
- through your browser. The Control port is used to startup and shutdown Jira.
- Use default ports (HTTP: 8080, Control: 8005) - Recommended [1, Enter], Set custom value for HTTP and Control ports [2]
- 2 ## 輸入2 自定義服務端口
- HTTP Port Number
- [8071]
- 8801
- Control Port Number
- [8077]
- 8802
- ## 安裝服務
- Jira can be run in the background.
- You may choose to run Jira as a service, which means it will start
- automatically whenever the computer restarts.
- Install Jira as Service?
- Yes [y, Enter], No [n]
- y
- Details on where Jira Software will be installed and the settings that will be used.
- Installation Directory: /opt/atlassian/jira
- Home Directory: /var/atlassian/application-data/jira
- HTTP Port: 8801
- RMI Port: 8802
- Install as service: Yes
- Install [i, Enter], Exit [e]
- Extracting files ...
- ## 啟動服務
- Please wait a few moments while Jira Software is configured.
- Installation of Jira Software 8.20.1 is complete
- Start Jira Software 8.20.1 now?
- Yes [y, Enter], No [n]
- y
- Please wait a few moments while Jira Software starts up.
- Launching Jira Software ...
- Installation of Jira Software 8.20.1 is complete
- Your installation of Jira Software 8.20.1 is now ready and can be accessed
- via your browser.
- Jira Software 8.20.1 can be accessed at http://localhost:8801
- Finishing installation ...
訪問：http://serverip:8801
2.3 初始化配置
獲取授權碼：
注冊賬號登錄：生成授權碼，激活實例;
三. Jira使用實踐
3.1 創建一個項目
注意：一個Jira 項目對應一個GitLab項目組;
3.2 為項目添加模塊
注意：一個Jira模塊對應一個GitLab項目;
3.3 配置WebHook系統， 網絡鉤子(webhook)
3.4 需求/任務管理
創建需求
這里在Jira上面把這個需求logging-error， 類型為故事 關聯到devops03-devops-service模塊;
3.5 發布Release
課程中把 發布對應為GitLab項目代碼庫中的版本分支;
issue關聯發布：可以想象成GitLab特性分支合并到版本分支;
四. Jira自動化實踐
工作流
工具鏈集成
4.1 需求與代碼關聯
1. 創建Jenkins作業并配置webhook
webhookData：這個變量存放的是Jira 傳遞的數據。
2. 為Jira配置一個系統級別的webhook
選項解釋：
- 指定Jenkins的webhook觸發器地址;
- 通過JQL指定，允許devops03這個項目進行觸發;
- 勾選動作，觸發事件;(我在jira做了什么操作之后能夠觸發)
3. Jenkins流水線配置
解析Jira傳遞過來的數據;
- webhookData = readJSON text: "${webhookData}"
- // Jira事件
- jiraEvent = webhookData.webhookEvent
- jiraProjectName = webhookData.issue.fields.project.name
- // 獲取gitlab參數
- gitlabProjects = []
- gitlabBranchName = webhookData.issue.key
- gitlabGroupName = jiraProjectName
- for (i in webhookData.issue.fields.components){
- gitlabProjects.add(i["name"])
- }
- currentBuild.description = "Trigger by ${jiraEvent} \n project: ${gitlabProjects} \n branch: ${gitlabBranchName}"
封裝GitLab API接口
https://docs.gitlab.com/ee/api/branches.html#create-repository-branch
- // 創建分支
- def CreateBranch(projectId, newBranchName, sourceBranchName){
- try {
- apiUrl = "projects/${projectId}/repository/branches?branch=${newBranchName}&ref=${sourceBranchName}"
- response = HttpReq('POST', apiUrl, "")
- }
- catch(Exception e) {
- println(e)
- }
- }
- // 獲取所有項目的id
- def GetProjectsId(gitlabGroupName, gitlabProjects){
- gitlabProjectIds = []
- for (project in gitlabProjects){
- id = GetProjectId(gitlabGroupName, project)
- println(id)
- if (id != 0){
- gitlabProjectIds.add(id)
- }
- }
- return gitlabProjectIds
- }
- // 根據項目名稱獲取項目id
- def GetProjectId(groupName, projectName){
- apiUrl = "projects?search=${projectName}"
- response = HttpReq('GET', apiUrl, "")
- response = readJSON text: response.content - "\n"
- if (response.size() > 1){
- for (i in response){
- println(i["path_with_namespace"])
- println(groupName + projectName)
- if (i["path_with_namespace"] == "${groupName}/${projectName}"){
- println(i["id"])
- return i["id"]
- }
- }
- } else {
- return response[0]["id"]
- }
- }
- // 封裝HTTP
- def HttpReq(reqType, reqUrl,reqBody ){
- def gitServer = "http://192.168.1.200/api/v4"
- withCredentials([string(credentialsId: '058b7907-ebe2-4d14-9b91-1ac72e071c59', variable: 'GITLABTOKEN')]) {
- response = httpRequest acceptType: 'APPLICATION_JSON_UTF8',
- consoleLogResponseBody: true,
- contentType: 'APPLICATION_JSON_UTF8',
- customHeaders: [[maskValue: false, name: 'PRIVATE-TOKEN', value: "${GITLABTOKEN}"]],
- httpMode: "${reqType}",
- url: "${gitServer}/${reqUrl}",
- wrapAsMultipart: false,
- requestBody: "${reqBody}"
- }
- return response
- }
Pipeline主程序
- pipeline {
- agent { label "build" }
- stages{
- stage("Process"){
- steps{
- script{
- println(gitlabProjects)
- println(gitlabBranchName)
- projectIds = GetProjectsId(gitlabGroupName, gitlabProjects)
- switch(jiraEvent) {
- case "jira:issue_created":
- println(projectIds)
- for (id in projectIds){
- CreateBranch(id, gitlabBranchName, "master")
- }
- break
- default:
- println("error...")
- break
- }
- }
- }
- }
- }
- }
4. 效果驗證
在Jira里面創建一個模塊和issue, 關聯項目;
Jenkins 流水線運行;
驗證Gitlab中多了分支;
責任編輯：姜華
來源：
DevOps云學堂
