devatherock/simple-slack

simple-slack

用于向Slack或其他支持Slack兼容传入webhook的聊天客户端（如Rocket.Chat）发送消息的CI插件。

镜像概述

simple-slack是一款轻量级CI插件，专为在CI/CD流程中集成消息通知功能而设计。通过配置简单的参数和密钥，即可将构建状态、提交信息等动态内容发送至Slack或兼容Slack webhook协议的聊天平台，帮助团队实时掌握构建进度和结果。

核心功能与特性

• 多平台支持：兼容Slack及所有支持Slack传入webhook的聊天客户端（如Rocket.Chat）
• 动态消息内容：消息文本支持Go模板语法，可引用运行时环境变量（需转换为驼峰式命名）
• 灵活配置：通过参数自定义消息高亮颜色、内容，通过密钥安全配置webhook地址
• CI工具集成：原生支持Drone、Vela等CI平台，可无缝嵌入构建流程

使用场景

适用于各类CI/CD流程中需要发送构建通知的场景，例如：

• 代码推送后通知构建状态（成功/失败/错误）
• 部署完成后发送部署信息（版本、部署链接、提交者）
• 自动化测试结果实时同步至团队聊天频道

配置说明

参数（Parameters）

可通过环境变量或CI配置文件设置以下参数：

密钥（Secrets）

需通过安全方式配置以下密钥：

使用方法

Docker直接运行

从工作目录执行以下命令：

bash
docker run --rm \
  -e SLACK_WEBHOOK=https://hooks.slack.com/services/... \  # Slack webhook地址
  -e PARAMETER_COLOR=#33ad7f \  # 消息高亮颜色
  -e PARAMETER_TEXT="成功: {{.BuildLink}} ({{.BuildRef}}) by {{.BuildAuthor}}" \  # 消息内容（Go模板）
  -e PARAMETER_CHANNEL="xyz" \  # 目标频道
  -e PARAMETER_TITLE="构建完成" \  # 消息标题
  -e BUILD_REF="refs/heads/master" \  # 构建分支引用
  -e BUILD_AUTHOR=octocat \  # 构建作者
  -e BUILD_LINK=http://github.com/octocat/hello-world \  # 构建链接
  devatherock/simple-slack:latest

Drone CI集成

在Drone流水线配置文件中添加以下步骤：

yaml
pipeline:
  notify_slack:
    when:
      event: [ push ]  # 触发事件：推送
      status: [ success, failure, error ]  # 触发状态：成功、失败、错误
    image: devatherock/simple-slack:latest
    secrets: [ slack_webhook ]  # 引用Slack webhook密钥
    settings:
      color: "#33ad7f"  # 消息高亮颜色
      text: |-  # 消息内容（支持多行）
        {{.DroneBuildStatus}} {{.DroneBuildLink}} ({{.DroneCommitRef}}) by {{.DroneCommitAuthor}}
        {{.DroneCommitMessage}}

Vela CI集成

在Vela配置文件中添加以下步骤：

yaml
steps:
  - name: notify_slack
    ruleset:
      event: [ push ]  # 触发事件：推送
      status: [ success ]  # 触发状态：成功
    image: devatherock/simple-slack:latest
    secrets: [ slack_webhook ]  # 引用Slack webhook密钥
    parameters:
      color: "#33ad7f"  # 消息高亮颜色
      text: |-  # 消息内容（支持多行）
        成功: {{.BuildLink}} ({{.BuildRef}}) by {{.BuildAuthor}}
        {{.BuildMessage}}