jgriff/hipchat-notification-resource

HipChat通知资源镜像

!pulls

该镜像为Concourse CI提供HipChat通知资源类型，支持向HipChat房间发送自定义或模板化消息，帮助团队实时获取CI/CD流水线状态。

核心功能

• 发送自定义文本或预设模板消息到HipChat
• 支持消息格式（HTML/文本）、颜色、通知开关配置
• 提供构建状态（开始/成功/失败等）和PR状态预设消息类型
• 动态替换消息中的tokens（包含Concourse元数据和文件读取）
• 可自定义消息中的流水线信息、Git信息和Fly命令提示

使用场景

• CI/CD流水线构建状态通知（开始、成功、失败、中止）
• 拉取请求（PR）构建状态通知
• 自定义业务事件通知（如部署完成、测试报告生成）

配置说明

资源类型定义

在Concourse配置中注册该资源类型：

yaml
resource_types:
  - name: hipchat-notification
    type: docker-image
    source:
      repository: jgriff/hipchat-notification-resource

资源配置（Source Configuration）

参数配置（Parameters）

必选参数

• message：发送到HipChat的文本内容，支持${key}格式的token替换

可选参数

• message_format：消息格式（"html"或"text"，默认"html"）
• tokens：自定义键值对或文件路径，用于替换message中的token（默认包含Concourse构建元数据）
• from：发送者名称（默认使用令牌对应的用户）
• color：消息颜色（可选值：yellow/red/green/purple/gray/random，默认yellow）
• notify：是否触发房间通知（true/false，默认false）

预设消息类型（Opinionated Parameters）

通过message_type快速配置常用通知类型：

可覆盖预设值，例如：

yaml
- put: hipchat
  params:
    message_type: succeeded
    notify: true

预设消息组件配置

通过message_type_config自定义预设消息组件：

yaml
- put: hipchat
  params:
    message_type: pr_succeeded
    message_type_config:
      pipeline_info: "Build #${BUILD_ID}"  # 自定义流水线信息
      git_info: disabled  # 关闭Git信息

部署示例

基础流水线通知

yaml
resources:
  - name: hipchat
    type: hipchat-notification
    source:
      hipchat_server_url: https://your-hipchat-server.com
      token: <your-token>
      room_id: 123

jobs:
  - name: build-job
    plan:
      - put: hipchat
        params: {message_type: started}
      # ... 构建步骤 ...
    on_success:
      put: hipchat
      params: {message_type: succeeded}
    on_failure:
      put: hipchat
      params: {message_type: failed}

自定义消息示例

yaml
- put: hipchat
  params:
    color: green
    from: "Concourse CI"
    message: "PR ${PR-TITLE} 构建成功 - 查看日志"
    tokens:
      PR-TITLE: file://output/pr-title.txt