构建后操作

如果我们在项目构建完成后，需要将项目进行部署，或者推送消息等等。这时，就需要用到 Jenkins 中的 Post-build Actions 了。

企业微信消息推送

实现效果：Jenkins 构建完成后，把构建结果推送到企业微信群中。

下面给出几种实现方案。

Qy Wechat Notification Plugin

安装插件 Qy Wechat Notification Plugin

20230319194319

企业微信群添加群机器人

#1	#2

添加 Post-build Actions

20230319195506

获取群机器人的 Webhook URL

20230319195641

配置 Post-build Actions

20230319195950

按照上面的步骤进行配置后，构建项目，然后就能在企业微信群中收到消息了。如下：

20230319200547

通过 Qy Wechat Notification Plugin 插件发送消息还是比较简单的，但是缺点也有，就是消息内容比较单一。

WXWork Notification

这个插件我还没用过，是偶然间发现的 😂。

20230319200909

Post build task

该插件用于在 Post-build Actions 中执行 Shell 脚本。步骤如下：

安装插件

20230319204116

企业微信群添加群机器人

#1	#2

获取群机器人的 Webhook URL

20230319195641

在 Post-build Actions 中填写 Shell

20230319204257

20230319204527

Shell 脚本如下：

#!/bin/bash
# 微信机器人的 Webhook
WEBHOOK_URL="微信机器人的 Webhook，请换成自己的 URL"
CONTENT_TYPE='Content-Type: application/json'

echo "### send message to wx，build result: ${BUILD_RESULT}"

curl "$WEBHOOK_URL" \
-H "$CONTENT_TYPE" \
-d '
  {
    "msgtype": "markdown",
    "markdown": {
      "content": "<font color=\"warning\">**【Jenkins 构建结果】**</font> \n
      > 任务序号：<font color=\"comment\">'"${BUILD_DISPLAY_NAME}"'</font>
      > 任务名称：<font color=\"comment\">'"${JOB_BASE_NAME}"'</font>
      > 构建分支：<font color=\"comment\">'"${GIT_BRANCH}"'</font>
      > 构建地址：<font color=\"comment\">[点击查看]('"${JOB_URL}"')</font>
      > 构建日志：<font color=\"comment\">[点击查看]('"${BUILD_URL}console"')</font> \n
      > 已完成构建请确认：<@DaiJunFeng>"
    }
  }
'

echo "### send message to wx finished！"

在这段 Shell 脚本中，我用到了一些环境变量，例如 BUILD_DISPLAY_NAME、JOB_BASE_NAME 等，这些变量是 Jenkins 内置的环境变量。可用的环境变量列表请见 env-varsopen in new window，可以在 Build Steps 中发现这个链接的入口，如下：

20230319205255

完成上面的步骤后，就可以构建项目了。如果一切顺利，那么会在对应的群中收到机器人的推送消息。

拓展

使用 Post build task 执行 Shell 脚本的方式是非常灵活的，它可以在构建完成后实现任何你想做的事。这里的 script 不局限于 Linux 中的命令，它可以是另一个工程或者工具包的启动命令，如下：

#!/bin/bash
# 在 msg.jar 中，你可以实现任何功能
java -jar msg.jar "${BUILD_DISPLAY_NAME}" "${JOB_BASE_NAME}"

Pipeline

上面介绍的几种方式，都是针对 Freestyle 类型的工程。如果是 Pipeline 项目，那么，我们只需在 Jenkinsfile 中编写脚本即可，原理都是一样的。

文件目录结构如下：

..
.
athena
|-script
|  |-build.sh
|  |-post-build.sh
|-Jenkinsfile

Pipeline 配置如下：

20230319211107

脚本文件如下：

Jenkinsfile

pipeline {
  agent any

  stages {
    stage('Pull') {
      steps {
        checkout scmGit(branches: [[name: '*/master']], extensions: [], userRemoteConfigs: [[credentialsId: 'dbe58879-a6f9-48c8-8c7a-77d750e358a5', url: 'https://gitee.com/djf1718/athena.git']])
      }
    }
    stage('Build') {
      steps {
        script {
          sh 'sh ./script/build.sh'
        }
      }
    }
  }

  post {
    success {
      script {
        def duration = "${currentBuild.durationString.replace(' and counting', '')}"
        env.BUILD_DURATION = duration
        sh 'export BUILD_RESULT=Success;export BUILD_NUM="${BUILD_DISPLAY_NAME}";export JOB_NAME="${JOB_BASE_NAME}";export BUILD_BRANCH="${GIT_BRANCH}";export BUILD_TIME="${BUILD_TIMESTAMP}";export BUILD_DURATION="${BUILD_DURATION}";export JOB_URL="${BUILD_URL}";export JOB_CONSOLE="${BUILD_URL}console";sh ./script/post-build.sh'
      }
    }
    failure {
      script {
        def duration = "${currentBuild.durationString.replace(' and counting', '')}"
        env.BUILD_DURATION = duration
        sh 'export BUILD_RESULT=Failed;export BUILD_NUM="${BUILD_DISPLAY_NAME}";export JOB_NAME="${JOB_BASE_NAME}";export BUILD_BRANCH="${GIT_BRANCH}";export BUILD_TIME="${BUILD_TIMESTAMP}";export BUILD_DURATION="${BUILD_DURATION}";export JOB_URL="${BUILD_URL}";export JOB_CONSOLE="${BUILD_URL}console";sh ./script/post-build.sh'
      }
    }
  }
}

build.sh

#!/bin/bash
echo "开始构建！"
pwd
npm install \
  && npm run build \
  && cd /usr/local/myapp/project/portal/athena \
  && mv dist "dist.$(date +%Y%m%d%H%M%S).bak" \
  && mv ${WORKSPACE}/docs/dist ./ \
  && curl -I -m 5 -s -w "%{http_code}\n" -o /dev/null athena.djf.xyz

echo "构建完成！"

post-build.sh

#!/bin/bash
WEBHOOK_URL=$WX_ROBOT_WEBHOOK_URL
CONTENT_TYPE='Content-Type: application/json'
STAUS_COLOR=$([ "${BUILD_RESULT}" == "Success" ] && echo 'info' || echo 'comment')

echo "### send message to wx，build result: ${BUILD_RESULT}"

curl "$WEBHOOK_URL" \
-H "$CONTENT_TYPE" \
-d '
  {
    "msgtype": "markdown",
    "markdown": {
      "content": "<font color=\"warning\">**【Jenkins 构建结果】**</font> \n
      > 任务序号：<font color=\"comment\">'"${BUILD_NUM}"'</font>
      > 任务名称：<font color=\"comment\">'"${JOB_NAME}"'</font>
      > 构建分支：<font color=\"comment\">'"${BUILD_BRANCH}"'</font>
      > 构建时间：<font color=\"comment\">'"${BUILD_TIME}"'</font>
      > 构建耗时：<font color=\"comment\">'"${BUILD_DURATION}"'</font>
      > 构建地址：<font color=\"comment\">[点击查看]('"${JOB_URL}"')</font>
      > 构建日志：<font color=\"comment\">[点击查看]('"${JOB_CONSOLE}"')</font>
      > 构建状态：<font color=\"'"$STAUS_COLOR"'\">**'"${BUILD_RESULT}"'**</font> \n
      > 已完成构建请确认：<@DaiJunFeng>"
    }
  }
'

echo "### send message to wx finished！"