gathertown/circleci-slack-notifier

circleci-slack-notifier

镜像概述

circleci-slack-notifier是一个基于Go语言开发的命令行工具，专门用于在CircleCI作业执行过程中向Slack频道发送通知。通过集成CircleCI环境变量和Slack Webhook，该工具能够自动将作业状态（成功、失败、取消等）实时推送至指定Slack频道，帮助开发团队及时掌握CI/CD流程状态。

核心功能与特性

• 多状态支持：支持CircleCI作业的多种状态通知，包括成功、失败、取消、超时等
• 环境变量集成：自动读取CircleCI环境变量（如作业名称、构建编号、分支信息等）
• 自定义消息：支持通过参数自定义通知标题、内容和颜色标识
• 轻量级设计：基于Go语言构建，体积小、启动快，适合CI/CD环境快速执行
• Slack适配：支持Slack Incoming Webhook协议，兼容标准Slack消息格式

使用场景

• CI/CD流程监控：实时获取代码构建、测试、部署等CircleCI作业的执行结果
• 团队协作：开发团队即时了解构建状态，快速响应失败或异常情况
• 自动化通知：替代手动检查CI状态的流程，提升团队协作效率
• 多环境适配：适用于开发、测试、生产等不同环境的CircleCI流水线

使用方法与配置说明

前提条件

• 已创建Slack Incoming Webhook（获取Webhook URL）
• CircleCI项目已配置并启用

环境变量配置

Docker运行示例

bash
docker run --rm \
  -e SLACK_WEBHOOK_URL="https://hooks.slack.com/services/XXX/XXX/XXX" \
  -e CIRCLECI_JOB_STATUS="success" \
  -e CIRCLE_PROJECT_REPONAME="my-project" \
  -e CIRCLE_BRANCH="main" \
  -e CIRCLE_BUILD_URL="https://circleci.com/gh/username/my-project/123" \
  gathertown/circleci-slack-notifier

命令行参数（可选）

可通过命令行参数覆盖环境变量配置：

bash
docker run --rm gathertown/circleci-slack-notifier \
  --webhook-url "https://hooks.slack.com/services/XXX/XXX/XXX" \
  --status "failure" \
  --project "my-project" \
  --branch "feature/new-endpoint" \
  --build-url "https://circleci.com/gh/username/my-project/124"

CircleCI配置集成示例

在.circleci/config.yml中添加通知步骤：

yaml
version: 2.1
jobs:
  build:
    docker:
      - image: cimg/go:1.20
    steps:
      - checkout
      - run: go build
      - run:
          name: Send Slack Notification
          when: always
          command: |
            docker run --rm \
              -e SLACK_WEBHOOK_URL="${SLACK_WEBHOOK_URL}" \
              -e CIRCLECI_JOB_STATUS="${CIRCLE_JOB_STATUS}" \
              gathertown/circleci-slack-notifier

注：需在CircleCI项目设置中添加SLACK_WEBHOOK_URL环境变量