实战-jira集成gitlab，jenkins持续集成部署实现方案

浅浅的花香味﹌ 2023-07-23 11:54 112阅读 0赞

# 一、概述 #

通常我们知道jira是软件项目流程管理工具，通过该工具，项目负责人可以分配人物给项目上的开发人员，开发人员随着开发的进度更新状态，进而反馈开发进度，项目的部署单独使用jenkins来实现。但是料想组内开发人员编写的代码能够通过jira一键发布打包，测试，合并到主分支，这样就更好。

# 二、jira自定义流程 #

## 2.1、自定义版本任务流程 ##

每次有一个版本需求的时候，我们需要自定义一个版本，命名为版本任务。版本任务的流程大致有**创建版本任务**\-**集成部署与测试**\-**DEV部署与测试-MST部署与测试**\-**版本发布**\-**版本验收**\-**清理版本任务** 这几个过程。

![format_png][]

![format_png 1][]

# #

![format_png 2][]

# #

![format_png 3][]

## 2.2、自定义集成任务流程 ##

每个版本需求可以细分出来很多任务需求，分配给对应的后端开发人员，前段开发人员。此时，我们也需要根据版本任务来创建每个开发人员的集成任务。开发任务主要包括**创建分支-集成开发与测试-集成合并-DEV测试与合并-MST测试与合并**等状态。具体流程和以上版本任务创建类似。

# 三、jira集成gitlab #

jira集成gitlab可以实现将git的commit信息上传到jira项目的问题中，方便管理人员或开发人员查阅。

## 3.1、gitlab中的配置 ##

1、登录gitlab后台，进入需要配置的项目，再点击 Settings->Integrations->JIRA，如图：

![format_png 4][]

2、配置jira信息，如图：

![format_png 5][]

以上参数都需要配置：

Active、Trigger、Merge request：都勾上

Web URL：JIRA项目的基础URL

Web API URL：如果在JIRA中没有特殊配置API的URL，还是填上面的URL

Username：JIRA账户用户名

Enter new password: JIRA账户密码

Transition ID：此时填写的在JIRA中对应的流程关闭ID，此时填1371，如图：

![format_png 6][]

3、填写完成后保存，若填写信息有误会保存失败。

4、测试在git中按照 jira任务编号+提交人+注释内容 的注释规范提交代码，jira中相关任务

下就会出现具体的提交信息：

![format_png 7][]

## 3.2 、jira中的配置 ##

若要进一步友好展示，可进行jira插件选择安装。

# 四、jira集成jenkins #

## 4.1、jenkins中的配置 ##

jenkins中需要安装的插件如下：

JIRA Integration for Jenkins

**Jira Issue Updater**

JIRA Pipeline Steps

JIRA plugin

**JIRA Trigger Plugin**

JiraTestResultReporter plugin

1、安装完 JIRA Trigger Plugin插件后，在系统管理->系统设置中，需要配置该插件和jira的关联：

![format_png 8][]

## 4.2、jira中的配置 ##

1、配置webhook，即网络钩子，jira->管理->系统->高级，找到WebHook：

![format_png 9][]

2、创建webhook，点击保存即可。如图：

![format_png 10][]

3、接口调试，通过访问 http://ip:20003/jenkins/jiratriggerwebhookreceiver/ ,可查看jenkins接口是的能调通，若出现下图，则表示可以调通：

![format_png 11][]

asd

4、配置任务（版本任务和集成任务）

上面分别创建了JIRA的两个任务流程，每个任务流程的每个按钮都分别有个唯一的key值，通过jira点击相应的按钮，通过唯一的key可以触发jenkins的脚本进行唯一的构建。

以版本任务进行阐释：

![format_png 12][]

**JQL filter**：指定触发对象，project=WUZ指的是jira中项目关键字为WUZ的项目，JQLfilter 包括：project、issue等

**Comment pattern：**jira备注中的comment，当用户在jira中添加指定备注时，会触发jenkins构建

**Jenkins parameter：**jenkins中的参数名称

**Issue attribute path：**jira issue中提取出得需要传给jenkins的属性值

注：JIRA filed ID 和 Custom Field ID 可通过http://120.79.168.18:20000/rest/api/2/field 地址查询

5、最后，只要修改jira的任务状态，就会触发jenkins自动构建，如图：

![format_png 13][]

# 五、jenkins shell脚本编写 #

现在jira集成了jenkins，通过触发jira的button实现jenkins的自动构建，那么如果我们同时开发和部署多个项目，又该如何处理呢？

所以为了做到**拓展性**，我们直接通过shell脚本编写（重点讲解从检出代码到打包部署的过程）。

## 5.1、项目检出 ##

可以根据JIRA上对应的不同项目名去检出对应的项目。

\# git 检出任务分支

function check\_out\_code()\{

code\_path=$1

fixVersionName=$2

echo "fixVersionName:$\{fixVersionName\}"

git clone http://$jenkins\_name:$jenkins\_password@gitlab.youxinsign.com/two/$\{project\_name\}.git $CLONE\_ADDRESS

git clone http://$jenkins\_name:$jenkins\_password@gitlab.youxinsign.com/two/$\{msf\_project\_name\}.git $MSF\_CLONE\_ADDRESS

if \[ ! -d $\{git\_check\_out\_code\_path\} \];

then

echo "项目还没被检出"

git init

git checkout -b $\{fixVersionName\}

else

echo "项目已经被检出"

cd $\{git\_check\_out\_code\_path\}

\#用代码库中的文件完全覆盖本地工作版本

existing\_branch=\`git branch -a\`

echo "远程仓库存在的分支:$\{existing\_branch\}"

for(( i=0;i<$\{\#existing\_branch\[@\]\};i++)) do

brachName=$(echo \\"$\{existing\_branch\[i\]\}\\" |sed 's/\\"//g')

if \[\[ $brachName =~ $\{fixVersionName\} \]\]

then

echo "更新分支:$\{fixVersionName\}"

git reset --hard

git pull origin $\{fixVersionName\}

done;

## 5.2、项目构建 ##

构建可以按模块构建，也可以构建整个项目

\# gradle按照模块的构建，根据不同的模块进行模块构建

function get\_deployed\_module()

if \[\[  $\{module\_code\} = "ADMIN" \]\]

then

deployed\_module='bee-core:bee\_admin'

if \[\[  $\{module\_code\} = "CLIENT" \]\]

then

deployed\_module='bee-core:bee\_client'

if \[\[  $\{module\_code\} = "API" \]\]

then

deployed\_module='bee-core:bee\_api'

if \[\[  $\{module\_code\} = "TSK" \]\]

then

deployed\_module='bee-core:bee\_taskserver'

if \[\[  $\{module\_code\} = "MSG" \]\]

then

deployed\_module='bee-core:bee\_message'

if \[\[  $\{module\_code\} = "ORGAN" \]\]

then

deployed\_module='bee-core:bee\_organ'

if \[\[  $\{module\_code\} = "ACT" \]\]

then

deployed\_module='bee-act:bee-act-admin'

\# gradle构建整个项目

function mvn\_build()

cd $\{build\_based\_path\}

if \[\[  $\{module\_code\} = "ALL" \]\]

then

gradle clean

gradle bootRepackage

else

gradle :$\{deployed\_module\}:clean

gradle :$\{deployed\_module\}:bootRepackage

echo -e "============Gradle构建完成=============="

## 5.3、项目部署 ##

由于模块较多，现在就举例说明后台管理模块的部署。具体流程

1、kill -9  admin\_pid

2、拷贝admin jar包到部署路径。

3、开启admin文件自动在服务器上传输(如果jenkins和jar包不在同一个服务器上则需要改流程)。

4、运行部署命令进行项目部署。

5、将部署成功的状态反馈到JIRA日志信息

\#部署admin 模块

function deploy\_admin\_module()

jira\_button\_code=$1

echo -e "============开启自动化部署admin！=============="

\#admin\_pid=\`ps -ef | grep $\{admin\_deploy\_path\}/$\{admin\_archive\_name\} | grep -v grep | awk '\{print $2\}'\`

admin\_pid=$(ssh -p 5000 root@132.124.2.10"ps -ef | grep $\{admin\_deploy\_path\}/$\{admin\_archive\_name\} | grep -v grep | awk  '\{print $2\}'"| awk '\{print $2\}')

if \[ -n "$admin\_pid" \]

then

echo "admin\_pid="$admin\_pid

ssh -p 5000 root@132.124.2.10 "kill -9 $\{admin\_pid\}"

echo "开始拷贝admin jar包到部署路径..."

cp -f $\{git\_check\_out\_code\_path\}/src/$\{projectName\}/$\{common\_module\}/$\{admin\_module\}/build/libs/$\{admin\_archive\_name\} $\{deploy\_path\}/$\{admin\_module\}

echo "开始启动程序..."

export BUILD\_ID=dontKillMe

\#sleep 30s

echo "开启admin文件自动在服务器上传输."

scp\_put 132.124.2.10 root '\*\*\*\*\*\*\*&' $\{deploy\_path\}/$\{admin\_module\}  $\{deploy\_path\}

if \[ $\{jira\_button\_code\} = "B471" \];

then

excute "/usr/bin/nohup nohup java -jar $\{admin\_deploy\_path\}/$\{admin\_archive\_name\} --spring.cloud.config.profile=master --spring.cloud.config.profile=master --spring.application.name=$\{admin\_spring\_application\_name\} --server.port=$\{admin\_port\} --eureka.client.service-url.defaultZone=http://$\{register\_center\_ip\_adress\}:$\{port\}/eureka -Xms64m -Xmx512m -XX:MaxMetaspaceSize=512m -XX:CompressedClassSpaceSize=64m -Xss256k -Xmn8m -XX:InitialCodeCacheSize=4m -XX:ReservedCodeCacheSize=8m -XX:MaxDirectMemorySize=16m  >/dev/null 2>&1 &"

else

excute "/usr/bin/nohup nohup java -jar $\{admin\_deploy\_path\}/$\{admin\_archive\_name\} --spring.cloud.config.profile=dev --spring.cloud.config.profile=dev --spring.application.name=$\{admin\_spring\_application\_name\} --server.port=$\{admin\_port\} --eureka.client.service-url.defaultZone=http://$\{register\_center\_ip\_adress\}:$\{port\}/eureka -Xms64m -Xmx512m -XX:MaxMetaspaceSize=512m -XX:CompressedClassSpaceSize=64m -Xss256k -Xmn8m -XX:InitialCodeCacheSize=4m -XX:ReservedCodeCacheSize=8m -XX:MaxDirectMemorySize=16m  >/dev/null 2>&1 &"

echo -e "============自动化部署admin成功!============"

echo -e '\\n\\n'

function get\_rest\_web\_api\_login()

echo "开始登录JIRA账户"

curl -c cookie.txt -d "os\_username="$\{os\_username\}"&os\_password="$\{os\_password\} -v $\{login\_api\_uri\}

cd $\{cookie\_file\_path\}

cookieContents=\`cat $\{cookie\_file\_path\}/cookie.txt | awk -F "\[JSESSIONID\]" '/JSESSIONID/\{print$0\}'\`

cookieContentsCutOut=$(echo $cookieContents | cut -d '/' -f 2)

JSESSIONID\_STRING=$(echo $\{cookieContentsCutOut\} |tr -d " ")

JSESSIONID=$\{JSESSIONID\_STRING:16\}

echo "开始获取登录后的JSESSIONID"

echo "cookie文件中包含jSessionId的内容为:::::$\{cookieContents\}"

echo "JIRA账户登录后的JSESSIONID的值为:::::$\{JSESSIONID\}"

function get\_jira\_login\_status()

echo "开始判断登录状态是否失效"

echo "登录状态信息为....$\{login\_status\_log\}"

if \[\[  $\{login\_status\_log\} =~ "errorMessages" \]\]

then

echo "JIRA还未登录，开始登录"

curl -c cookie.txt -d "os\_username="$\{os\_username\}"&os\_password="$\{os\_password\} -v $\{login\_api\_uri\}

cd $\{cookie\_file\_path\}

cookieContents=\`cat $\{cookie\_file\_path\}/cookie.txt | awk -F "\[JSESSIONID\]" '/JSESSIONID/\{print$0\}'\`

cookieContentsCutOut=$(echo $cookieContents | cut -d '/' -f 2)

JSESSIONID\_STRING=$(echo $\{cookieContentsCutOut\} |tr -d " ")

JSESSIONID=$\{JSESSIONID\_STRING:16\}

else

echo "JIRA已经登录"

function add\_post\_build\_comments()

commentCotents=$1

echo "JIRA\_ISSUE\_KEY\[$JIRA\_ISSUE\_KEY\]..."

echo "开始增加构建后的JIRA日志信息"

echo "add\_post\_build\_comments参数:"$commentCotents

add\_post\_build\_comments\_status\_result=\`curl --cookie JSESSIONID=$\{JSESSIONID\} --request POST --data '\{"body": "'$\{commentCotents\}'"\}' --header 'Accept: application/json' --header 'Content-Type: application/json' $\{issue\_api\_uri\}/$\{JIRA\_ISSUE\_KEY\}/comment\`

echo "版本分支创建的结果:$\{add\_post\_build\_comments\_status\_result\}"

if \[\[  $\{add\_post\_build\_comments\_status\_result\} =~ "errorMessages" \]\]

then

echo "JIRA 版本分支构建JIRA日志信息增加失败"

else

echo "JIRA 版本分支构建JIRA日志信息增加成功"

除此之前还有一键状态更新，一键代码合并等。

**总结：**虽然作为后端开发人员可能不太容易，因为脚本你没有运维人员熟悉。但是踏踏实实，一步一个脚印，会让你的知识更加全面。

[format_png]: /images/20230528/74d81b04589943b3a726efab0cb5335a.png
[format_png 1]: /images/20230528/0723b8d78c5c4e0db5a7c6f986fb15c7.png
[format_png 2]: /images/20230528/728b930ddffd4b27a3a4604540cd5984.png
[format_png 3]: /images/20230528/239cd7c4451746fbb1720fca4a5f2ef2.png
[format_png 4]: /images/20230528/83eab67317004ef8bd3fb100faa7e490.png
[format_png 5]: /images/20230528/4236138035044d63ac7d43c843817840.png
[format_png 6]: /images/20230528/0e5cd1f503ae4b099483fbdbfa08ab4b.png
[format_png 7]: /images/20230528/58e390533685482da3ff15fc2c05a523.png
[format_png 8]: /images/20230528/23f0089666a740768abc5265b0890a6f.png
[format_png 9]: /images/20230528/20b4817b184c41579c8bb5056d62fb62.png
[format_png 10]: /images/20230528/88abf6f009f74af3a63e999919b28f4c.png
[format_png 11]: /images/20230528/dcd040a28d70479588514f88715b4ff9.png
[format_png 12]: /images/20230528/71f54a0bbb5f4ec6bab2d4434fa55878.png
[format_png 13]: /images/20230528/404369c2e74c4cafa9ab5db83fe57238.png