Jenkins-实现钉钉报警（pipline）

一.前言

最近打算在项目发版的时候，Jenkins实现钉钉告警，本文用的pipeline结合钉钉实现发版告警。

效果图：

发版成功通知，内容包括版本更新记录。

 

发版失败通知

 

 

二.配置步骤

1.钉钉配置

需要在钉钉电脑端操作

建群-配置机器人-取得讨论组token

 

 

 

 

 

 

 

 记录下wehhook地址，后面用得上。

2.Jenkins配置

1.1 安装jenkins插件

搜索dingding

 

 

1.2 添加机器人

进入系统配置

 

添加机器人

 

 

 记录机器人ID，后面用得上

3.pipeline配置

#!groovy
pipeline{
agent any
environment{  
    REPOSITORY="https://e.coding.net/jeff2020/helloworld.git"
    PROJECK="zsccv7"
    WEBURL="http://zsccv7.jeff.com"
    WEBDIR="/tmp"

}
stages {
  stage("拉取代码") {
      steps {
          echo "start fetch code from git:${REPOSITORY}"
          deleteDir()
          checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [[$class: 'CleanBeforeCheckout']], submoduleCfg: [], userRemoteConfigs: [[url: 'https://e.coding.net/jeff2020/helloworld.git']]])
      }    
   }
   stage('输出日志') {
            steps {
                script{
                    //调用方法得到日志 并 输出
                    def changeString = getChangeString()
                    echo "$changeString"
                }
            }
        }
   
    stage("更新代码") {
      steps {      
　　　　　　　此处填写更新代码的操作
           }
           }   
    }
   }
  post {
    success {
     echo "发版成功"
     dingtalk (
     robot: 'b9b37ae7-3132-4d9b-9b07-7021ad0e11be',
     type: 'LINK',
     at:[],
     atAll: false,
     title: "${PROJECK}上线成功!",
     text:["更新记录\n$changeString"],
     messageUrl: "${WEBURL}",
     picUrl:'http://kmzsccfile.kmzscc.com/upload/2020/success.jpg',
     singleTitle:'',
     btns: [],
     hideAvatar: false
     )
    }
    failure {
     echo "上线失败"
     dingtalk (
     robot: 'b9b37ae7-3132-4d9b-9b07-7021ad0e11ae',
     type: 'LINK',
     at:["12333333333"],
     atAll: false,
     title: "${PROJECK}上线失败!",
     text:["请管理员及时处理！"],
     messageUrl: "http://47.112.122.190:52000/",
     picUrl:'http://kmzsccfile.kmzscc.com/upload/2020/error.jpg',
     singleTitle:'',
     btns: [],
     hideAvatar: false
     )  
    }    
    
    // 省略其他条件块
  }

}

@NonCPS
def getChangeString() {
    MAX_MSG_LEN = 100
    def changeString = ""

    echo "Gathering SCM changes"
    def changeLogSets = currentBuild.changeSets
    for (int i = 0; i < changeLogSets.size(); i++) {
        def entries = changeLogSets[i].items
        for (int j = 0; j < entries.length; j++) {
            def entry = entries[j]
            truncated_msg = entry.msg.take(MAX_MSG_LEN)
            changeString += " - ${truncated_msg} [${entry.author}]\n"
        }
    }
    if (!changeString) {
        changeString = " - No new changes"
    }
    return changeString
}

此pipeline包含两个点重要内容

1）获取项目发版变更记录

@NonCPS
def getChangeString() {
    MAX_MSG_LEN = 100
    def changeString = ""

    echo "Gathering SCM changes"
    def changeLogSets = currentBuild.changeSets
    for (int i = 0; i < changeLogSets.size(); i++) {
        def entries = changeLogSets[i].items
        for (int j = 0; j < entries.length; j++) {
            def entry = entries[j]
            truncated_msg = entry.msg.take(MAX_MSG_LEN)
            changeString += " - ${truncated_msg} [${entry.author}]\n"
        }
    }
    if (!changeString) {
        changeString = " - No new changes"
    }
    return changeString
}　

 

2）钉钉配置说明

dingtalk (
#机器人ID
robot: 'b9b37ae7-3132-4d9b-9b07-7021ad0e11be', 
#数据类型
type: 'LINK',
#钉钉群里需要@的负责人
at:["18217472422"],
atAll: false,
#标题
title: "${PROJECK}上线成功!",
#报警内容
text:["更新记录\n$changeString"],
messageUrl: "${WEBURL}",
#图片链接地址
picUrl:'http://kmzsccfile.kmzscc.com/upload/2020/success.jpg',
singleTitle:'',
btns: [],
hideAvatar: false
)

详细说明请参考插件文档

https://jenkinsci.github.io/dingtalk-plugin/guide/pipeline.html