karenc/concourse-slack-resource

concourse-slack-resource镜像说明

镜像概述

concourse-slack-resource是Concourse CI的扩展资源，允许用户以机器人身份在Slack平台上读取和发送消息，支持消息过滤、解析及与CI/CD流水线的集成，帮助实现自动化的消息通知或指令响应。

核心功能

1. 消息读取：读取机器人加入的所有频道消息（最多支持50个频道）；
2. 消息发送：以机器人身份向指定频道发送消息；
3. 消息过滤与解析：通过正则表达式过滤消息，并提取分组内容作为流水线参数；
4. 流水线集成：作为Concourse资源类型，可触发流水线任务或发送任务结果通知。

使用场景

• CI/CD流水线执行成功/失败时自动发送Slack通知；
• 接收Slack中的指令（如"触发构建"）并启动对应的流水线任务；
• 自动化回复Slack中的常见问题或状态查询。

配置说明

前置条件

1. 创建Slack应用及机器人：访问Slack API创建应用和机器人；
2. 获取必要凭证：在应用的"OAuth & Permissions"页面获取OAuth Access Token和Bot User OAuth Access Token；
3. 获取机器人用户ID：在Slack网页端@机器人并复制URL末尾的ID（如ABC123GHI）；
4. 配置机器人权限：需开启以下Scopes：channels:history、chat:write:bot、bot、users:read。

流水线配置示例

将以下内容保存为pipeline.yml：

yaml
---
resource_types:
  - name: slack
    type: docker-image
    source:
      repository: karenc/concourse-slack-resource

resources:
  - name: bot-read
    type: slack
    source:
      user_access_token: ((slack-user-access-token))
      bot_access_token: ((slack-bot-access-token))
      bot_user_id: ((slack-bot-user-id))
      regexp: '<@((slack-bot-user-id))> (.*)'
    check_every: 10s

  - name: bot-write
    type: slack
    source:
      user_access_token: ((slack-user-access-token))
      bot_access_token: ((slack-bot-access-token))
      bot_user_id: ((slack-bot-user-id))

jobs:
  - name: slack-interaction
    plan:
      - get: bot-read
        trigger: true
        version: every
      - put: bot-write
        params:
          text: '{{bot-read/message_text_0}} :tada:'
          channel: '{{bot-read/channel}}'

部署命令

1. 准备vars.yml文件存储凭证：

yaml
slack-user-access-token: xoxo-1234567890-abcdefghij
slack-bot-access-token: xoxo-1234567890-klmnopqrst
slack-bot-user-id: ABC123GHI

2. 创建流水线：

bash
fly -t example sp -p slack-bot -c pipeline.yml -l vars.yml

3. 启动流水线：

bash
fly -t example up -p slack-bot

调试方法

若流水线未触发，可进入资源容器查看日志：

bash
fly -t example intercept -c slack-bot/bot-read

查看/tmp/body.json（Concourse发送的请求数据）和/tmp/check_.log（检查日志），或手动执行检查脚本：

bash
cat /tmp/body.json | /opt/resource/check