flavorjones/webhook-notification-resource

Concourse Webhook通知资源

用于从Concourse CI管道向任何Webhook发送通知消息。

核心功能

• 为每个Concourse任务状态提供带彩色图标的预格式化Markdown消息
• 集成Gitter活动流
• 可扩展设计，便于添加其他Webhook支持

背景

Concourse是开源的持续集成工具，适用于复杂管道场景。当任务成功/失败时，发送通知消息是常见需求，本资源简化了这类简单集成的消息发送流程。

源配置

必填参数

• adapter：服务适配器名称（如GitterActivityFeedAdapter、MockTeapot）
• url：目标Webhook URL

可选参数

• dryrun：是否仅模拟请求（默认false）

调用说明

• check和in步骤：无操作
• put步骤：连接Webhook并发送消息

发送预格式化消息

通过status参数指定状态，使用预定义消息：

• aborted/errored/failed/pending/started/succeeded：对应预格式化消息
• 其他值：使用未知状态消息

发送自定义消息

指定以下任一参数：

• message：Markdown格式的通知文本
• message_file：包含Markdown文本的文件路径（支持Concourse元数据变量）

示例用法

预格式化消息配置

yml
resource_types:
- name: webhook-notification
  type: docker-image
  source:
    repository: flavorjones/webhook-notification-resource

resources:
- name: foobar-gitter-channel
  type: webhook-notification
  source:
    adapter: GitterActivityFeedAdapter
    url: ((webhook_url))

jobs:
- name: run-some-tests
  plan:
    - task: run-a-test
      config: { ... }
  on_success: { put: foobar-gitter-channel, params: {status: "succeeded"} }
  on_failure: { put: foobar-gitter-channel, params: {status: "failed"} }
  on_error:   { put: foobar-gitter-channel, params: {status: "errored"} }
  on_abort:   { put: foobar-gitter-channel, params: {status: "aborted"} }

自定义消息配置

yml
resource_types:
- name: webhook-notification
  type: docker-image
  source:
    repository: flavorjones/webhook-notification-resource

resources:
- name: foobar-gitter-channel
  type: webhook-notification
  source:
    adapter: GitterActivityFeedAdapter
    url: ((webhook_url))

jobs:
- name: post-a-message-to-gitter
  plan:
  - put: foobar-gitter-channel
    params:
      message: "_This_ is a *markdown* message about [${BUILD_PIPELINE_NAME}/${BUILD_JOB_NAME}/${BUILD_NAME}](${BUILD_URL})"

Gitter Webhook配置

参考文档：docs/gitter-create-webhook.md

路线图

• 支持HTTP代理或隧道连接

贡献指南

欢迎提交PR或Issue。添加新服务适配器需：

1. 分叉仓库
2. 编写适配器模块（含.post方法）
3. 添加测试

开发与测试

无本地Ruby环境

sh
make test

有本地Ruby环境

sh
bundle install && bundle exec rake test

许可证

MIT（详见仓库LICENSE文件）