Jenkins Slack 插件使用教程

最新推荐文章于 2025-04-09 11:30:40 发布

叶展冰Guy

最新推荐文章于 2025-04-09 11:30:40 发布

阅读量999

点赞数 28

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00912/article/details/147089419

Jenkins Slack 插件使用教程

slack-plugin A Jenkins plugin for posting notifications to a Slack channel 项目地址: https://gitcode.com/gh_mirrors/sl/slack-plugin

1. 项目介绍

Jenkins Slack 插件是一个开源项目，它为 Jenkins 提供了与 Slack 或类似应用（如 RocketChat 和 Mattermost）的集成。通过该插件，Jenkins 可以将构建通知、错误报告以及其他相关信息发送到 Slack 频道，方便开发团队成员及时获取信息并采取行动。

2. 项目快速启动

安装 Jenkins Slack 插件

登录 Jenkins 服务器。
导航到 Jenkins 主页，选择“管理 Jenkins”。
点击“管理插件”，然后在“可用”选项卡中搜索“slack”。
勾选 Slack 插件并点击安装。

配置 Slack 应用

前往 Slack API 页面并点击“创建新应用”。
从应用清单中选择“从应用清单”。
选择您的 Slack 工作区。
删除 Slack 提供的示例清单。
点击 YAML 选项卡。
将以下内容粘贴到文本框中：

display_information:
  name: Jenkins
features:
  bot_user:
    display_name: Jenkins
    always_online: true
oauth_config:
  scopes:
    - channels:read
    - chat:write
    - chat:write.customize
    - files:write
    - reactions:write
    - users:read
    - users:read.email
    - groups:read
settings:
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false

点击“下一步”，然后点击“创建”。
点击“将应用到工作区”，然后点击“允许”。
在侧边栏中点击“OAuth & 权限”，复制“Bot User OAuth Access Token”。

配置 Jenkins

在 Jenkins 中找到 Slack 配置，路径为“管理 Jenkins → 系统”。
点击“添加”，创建一个新的“秘密文本”凭证，使用刚才复制的 bot 用户令牌。
在下拉菜单中选择新的“秘密文本”。
添加一个默认频道（验证连接成功后可以移除）。
勾选“自定义 Slack 应用 bot 用户”选项。
将 Jenkins bot 用户邀请到您希望接收通知的 Slack 频道中。
点击“测试连接”，Jenkins 将向默认频道或默认成员发送一条消息。

3. 应用案例和最佳实践

通知所有作业

如果您希望为所有作业配置 Slack 通知，可以考虑安装另一个插件“Global Slack Notifier”。

流水线作业示例

slackSend color: "good", message: "来自 Jenkins 流水线的消息"

此外，您可以通过传递附件或块来发送复杂消息（需要 bot 用户和自定义 Slack 应用）：

def attachments = [
    [
        text: "我发现你的信念令人不安！",
        fallback: "嘿， Vader 似乎对你很生气。",
        color: "#ff0000"
    ]
]

slackSend(
    channel: "#general",
    attachments: attachments
)

文件上传

node {
    sh "echo 嘿 > blah.txt"
    slackUploadFile(
        filePath: "*.txt",
        initialComment: "HEY HEY"
    )
}

线程支持

def slackResponse = slackSend(
    channel: "cool-threads",
    message: "这是主消息"
)

slackSend(
    channel: slackResponse.threadId,
    message: "线程回复 #1"
)

slackSend(
    channel: slackResponse.threadId,
    message: "线程回复 #2"
)

更新消息

def slackResponse = slackSend(
    channel: "updating-stuff",
    message: "这是主消息"
)

slackSend(
    channel: slackResponse.channelId,
    message: "更新后的消息",
    timestamp: slackResponse.ts
)