freelock/matrix-notification-resource

Concourse CI Matrix通知资源

该资源用于向Matrix发送通知消息，支持字符串消息或模板化消息，借鉴了https://github.com/cloudfoundry-community/slack-notification-resource%E7%9A%84%E8%AE%BE%E8%AE%A1%EF%BC%8C%E6%96%87%E6%9C%AC%E5%8F%8A%E6%96%87%E6%9C%AC%E6%96%87%E4%BB%B6%E5%8F%82%E6%95%B0%E7%9A%84%E4%BD%BF%E7%94%A8%E6%96%B9%E5%BC%8F%E4%B8%8ESlack%E8%B5%84%E6%BA%90%E4%B8%80%E8%87%B4%E3%80%82

安装配置

在Concourse CI的pipeline配置中添加资源类型：

yaml
resource-types:
- name: matrix-notification-resource
  type: docker-image
  source:
    repository: freelock/matrix-notification-resource

Matrix账号注册

资源需要Matrix用户的访问令牌（access token），需手动创建账号并获取令牌：

1. 在Matrix homeserver创建用户账号；
2. 使用Curl获取令牌：

bash
curl -XPOST -d '{"type":"m.login.password", "user":"example", "password":"wordpass"}' "http://matrix.org/_matrix/client/api/r0/login"

返回结果中的access_token即为所需令牌； 3. 将该账号邀请至目标房间并接受邀请。

源配置参数

核心功能（out操作）

向指定Matrix房间发送消息，支持以下参数：

• text：直接发送的文本内容；
• text_file：包含文本内容的文件路径；
• msgtype：可选，覆盖源配置的消息类型；
• data_file：可选，覆盖源配置的数据文件；
• trigger：可选，自定义触发标识（如success/fail）；
• always_notify：布尔值，是否在文本为空时仍发送通知；
• prefix：消息前缀（如管道名称）；
• link：布尔值，是否添加构建链接。

使用示例

资源配置

yaml
resources:
- name: matrix-notification
  type: matrix-notification-resource
  source:
    matrix_server_url: https://matrix.org
    token: {{matrix_token}}
    room_id: {{matrix_room_id}}
    msgtype: com.freelock.data
    data_file: data

发送通知（out操作）

yaml
- put: matrix-notification
  params:
    text_file: results/message.txt
    text: |
      构建已完成，查看详情：
      http://my.concourse.url/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME
      结果：$TEXT_FILE_CONTENT

发送自定义JSON数据

yaml
- put: matrix-notification
  params:
    msgtype: com.freelock.data
    data_file: matrix-notification/data
    trigger: fail
    message: 测试失败

注意事项

• check和in操作未支持；
• 使用自定义消息类型时，资源会自动附加构建元数据（管道名称、任务名称、构建ID等）；
• 自定义数据文件需为合法JSON格式。