GitLab-CI 通过钉钉发送消息

发表于 阅读次数： 本文字数： 384 阅读时长 ≈ 1 分钟

在使用Gitlab进行CI/CD的时候，希望在任务结束的时候(成功或失败)能有对应的消息通知机制， 通过钉钉发送消息。

前提

钉钉群添加机器人获取token,secret 备用

编写python发送消息任务程序

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#!/usr/bin/env python
# encoding=utf-8
# __Auth__:RanLH

import sys
import argparse
from dingtalkchatbot.chatbot import DingtalkChatbot, ActionCard, CardItem


def send_notify(webhook,secret,message):
    # 初始化机器人小丁
    bot = DingtalkChatbot(webhook,secret,pc_slide=False) 
    bot.send_link(title=message[0],text=message[1],message_url=message[2],pic_url=message[3])

def set_actioncard(args):
    #V_TITLE = "ci任务执行结果通知"
    # 失败时：任意任务都发通知
    if args.CI_JOB_STATUS == "failed":
        V_IMG = "https://s2.loli.net/2022/09/28/WpklwGHgMZuoCXU.png"
        V_STATUS = "执行失败 "
    # 成功时：仅 merge 任务发通知
    elif args.CI_JOB_STATUS == "success" and args.CI_JOB_NAME == "Merge_Branch":
        V_IMG = "https://s2.loli.net/2022/09/28/R8QKZqrXHUedmB5.png"
        V_STATUS = "执行成功 "
    else:
        sys.exit(10)
    # link 格式文本
    V_TITLE = "任务 %s %s" %(args.CI_JOB_NAME,V_STATUS)
    V_TEXT = "项目:  %s  \n作者: %s" %(args.CI_PROJECT_TITLE,args.GITLAB_USER_NAME)
    message_url = args.CI_JOB_URL
    pic_url = V_IMG

    return [V_TITLE,V_TEXT,message_url,pic_url]

def get_args():
    parser = argparse.ArgumentParser(description='钉钉发送job结果消息、需要传入参数：')
    parser.add_argument('D_TOKEN', help='钉钉机器人 TOKEN')
    parser.add_argument('D_SECRET', help='钉钉机器人 SECRET')
    parser.add_argument('CI_JOB_STATUS', help='变量 CI_JOB_STATUS')
    parser.add_argument('CI_JOB_URL', help='变量 CI_JOB_URL')
    parser.add_argument('CI_JOB_NAME', help='变量 CI_JOB_NAME')
    parser.add_argument('CI_PROJECT_TITLE', help='变量 CI_PROJECT_TITLE')
    parser.add_argument('GITLAB_USER_NAME', help='变量 GITLAB_USER_NAME')
    return parser.parse_args()
 
def main():
    args = get_args()
    # 钉钉机器人 webhook 地址
    url = "https://oapi.dingtalk.com/robot/send?access_token="
    webhook = url + args.D_TOKEN
    secret = args.D_SECRET
    #设置发送的消息内容
    message = set_actioncard(args)
    send_notify(webhook,secret,message)

if __name__ == '__main__':
    main()

集成到 CI

  1. 在Gitlab群组添加自定义变量
  2. 添加以下内容到 .gitlab-ci.yml 配置 CI 任务
1
2
after_script:
  - python dingtalk_bot.py $D_TOKEN $D_SECRET $CI_JOB_STATUS $CI_JOB_URL $CI_JOB_NAME $CI_PROJECT_TITLE $GITLAB_USER_NAME