mockersf/concourse-slack-notifier

concourse-slack-notifier

Concourse的结构化Slack通知资源，用于向Slack发送CI/CD流水线状态通知。该资源基于Rust重写，扩展了原arbourd/concourse-slack-alert-resource的功能，支持从文件读取消息内容及发送格式统一的短消息。通知内容利用Concourse资源元数据自动构建，包含流水线、任务、构建编号及URL等关键信息。

!https://raw.githubusercontent.com/mockersf/concourse-slack-notifier/master/img/custom.png

安装

在流水线配置的resource_types部分添加以下内容以使用该资源：

yaml
resource_types:
- name: slack-notifier
  type: docker-image
  source:
    repository: mockersf/concourse-slack-notifier

有关添加resource_types的更多细节，请参考https://concourse-ci.org/resource-types.html%E3%80%82

源配置（Source Configuration）

• url: 必填。Slack Webhook URL。
• channel: 可选。消息发送目标频道，未设置时使用Webhook默认频道。
• concourse_url: 可选。Concourse外部访问URL，默认使用环境变量ATC_EXTERNAL_URL。
• username: 可选。Concourse本地用户（或基础认证）用户名，非公开流水线使用fixed或broke类型通知时必填。
• password: 可选。Concourse本地用户（或基础认证）密码，非公开流水线使用fixed或broke类型通知时必填。
• ca_cert: 可选。Concourse实例的CA证书，用于验证自定义CA或自签名证书。
• ignore_ssl: 可选。允许不安全访问Concourse（不验证证书）。
• disabled: 可选。禁用该资源的所有通知。

配置示例：

yaml
resources:
- name: notify
  type: slack-notifier
  source:
    url: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

行为

check: 无操作。

in: 无操作。

out: 发送消息到Slack。

根据通知类型和模式发送结构化消息到Slack。

参数（Parameters）

• alert_type: 可选。通知类型，详见通知类型，默认custom。
• channel: 可选。消息发送频道，默认使用源配置中的channel。
• message: 可选。通知顶部状态消息，默认使用通知类型名称。
• message_file: 可选。消息内容文件路径。
• fail_if_message_file_missing: 可选。当message_file设置但文件不存在时是否失败，默认false。
• color: 可选。通知栏颜色（十六进制值），默认使用通知类型的图标颜色。
• mode: 可选。消息信息展示量，详见展示模式，默认normal_with_info。
• disabled: 可选。禁用当前通知。
• message_as_code: 可选。当模式为normal或normal_with_info时，消息文本将被```包裹。

基础配置示例：

yaml
jobs:
  plan:
  - put: notify

带通知类型、模式和消息的配置示例：

yaml
jobs:
  plan:
  - put: notify
    params:
      message: 任务执行失败
      mode: concise
      alert_type: failed

通知类型（Alert Types）

• custom
  

• success
  

• failed
  

• started
  

• aborted
  

• fixed
  仅当前构建成功且上一次构建失败时发送通知。非公开流水线需配置username和password。
  

• broke
  仅当前构建失败且上一次构建成功时发送通知。非公开流水线需配置username和password。
  

展示模式（Modes）

不同模式下的通知信息展示量示例：

• concise（简洁模式）
  

• normal（标准模式）
  

• normal_with_info（带详细信息模式）