slapers/hipchat-notification

HipChat通知资源镜像

镜像概述

本镜像基于https://github.com/slapers/hipchat-notification-resource%E6%9E%84%E5%BB%BA%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%90%91HipChat%E5%8F%91%E9%80%81%E9%80%9A%E7%9F%A5%E6%B6%88%E6%81%AF%EF%BC%8C%E6%94%AF%E6%8C%81%E7%9B%B4%E6%8E%A5%E5%AD%97%E7%AC%A6%E4%B8%B2%E6%B6%88%E6%81%AF%E6%88%96%E6%A8%A1%E6%9D%BF%E5%8C%96%E6%B6%88%E6%81%AF%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8ECI/CD%E7%AD%89%E8%87%AA%E5%8A%A8%E5%8C%96%E5%9C%BA%E6%99%AF%E7%9A%84%E9%80%9A%E7%9F%A5%E9%9C%80%E6%B1%82%E3%80%82

核心功能

• 发送字符串形式的通知消息
• 支持模板化消息，通过参数替换动态生成内容
• 自定义通知来源名称
• 可选消息颜色（黄色、红色、绿色等）
• 支持HTML或文本格式的消息
• 可配置是否触发房间内用户通知

使用场景

• CI/CD流程（如Concourse CI）中的构建结果通知
• 系统事件触发的HipChat房间消息推送
• 自动化任务完成后的状态通知

配置说明

资源类型配置

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

源配置（Source Configuration）

• hipchat_server_url：必填，HipChat服务器API地址，如[***]
• token：必填，HipChat认证令牌
• room_id：可选，接收通知的房间ID（当hipchat_server_url未包含房间ID时必填）

输出操作（Out）：发送消息到HipChat房间

参数说明：

• from：必填，发送通知的系统名称
• message：必填，消息内容（支持两种形式）
  • 字符串形式：直接填写文本内容
  • 对象形式：包含template（必填，模板字符串，用${param_key}占位）和params（必填，替换模板的参数，支持从文件读取值，格式为file://路径）
• color：可选，消息颜色，可选值为yellow、red、green、purple、gray、random，默认yellow
• message_format：可选，消息格式，html或text，默认html
• notify：可选，是否触发房间通知（0=否，1=是），默认0

部署示例

Concourse CI资源配置示例

yaml
resources:
- name: hipchat-notification
  type: hipchat-notification-resource
  source:
    hipchat_server_url: https://api.hipchat.com
    token: 14376e01-3152-4710-a830-aaf77e48c047
    room_id: 1

发送模板化消息示例

yaml
- put: hipchat-notification
  params:
    color: green
    from: "Concourse CI"
    message:
      template: "${PR-TITLE} 构建成功 - 构建日志"
      params:
        PR-TITLE: file://output-directory/pr-title