Drone 插件市场 > Matrixchat Notifications
matrix.svg

Matrixchat Notifications

by SpotlightKid

MIT License
插件源码README插件镜像 (Image)

一个从 CI 流水线 (Pipeline) 步骤向 Matrix 聊天室发送通知的插件。支持 Jinja 消息模板和 Markdown 渲染。

YAML 配置示例

kind: pipeline
type: docker
name: default

steps:
- name: notify
  image: spotlightkid/drone-matrixchat-notify
  settings:
    homeserver: 'https://matrix.org'
    roomid: '!xxxxxx@matrix.org'
    userid: '@drone-bot@matrix.org'
    password:
      from_secret: drone-bot-pw
    markdown: 'yes'
    template: |
      `${DRONE_REPO}` build #${DRONE_BUILD_NUMBER} status: **${DRONE_BUILD_STATUS}**

      ${DRONE_PULL_REQUEST_TITLE}](${DRONE_COMMIT_LINK})

字段属性说明

  • roomid

    string必填项

    要发送信息的矩阵聊天室的 ID（ID，而不是别名）。

    默认值：none

  • userid

    string必填项

    要发送信息的矩阵用户 ID（ID，而不是用户名）。

    默认值：none

  • password

    string必填项

    用于验证使用 `userid`设置的用户的密码。 需要密码或访问令牌。

    推荐使用密钥 (Secret) 功能

    默认值：none

  • accesstoken

    string必填项

    用于身份验证的访问令牌，而不是 "密码"。 需要访问令牌或密码。

    推荐使用密钥 (Secret) 功能

    默认值：none

  • allowed_attrs

    array可选项

    以逗号分隔的 HTML 属性名称列表或字符串，或将标记名称映射为属性名称列表的 dict。

    默认值：`DEFAULT_ALLOWED_ATTRS`

  • allowed_tags

    array可选项

    以逗号分隔的 HTML 标记名称列表或字符串。 未包含的 HTML 标记将从通过 渲染 Markdown 消息模板所生成的 HTML 输出中剔除。

    默认值：`DEFAULT_ALLOWED_TAGS`

  • deviceid

    string可选项

    与访问令牌一起发送的设备 ID。

    默认值：none

  • devicename

    string可选项

    与访问令牌一起发送的设备名称。

    默认值：none

  • homeserver

    string可选项

    Matrix homeerver URL。

    默认值：https://matrix.org

  • jinja

    boolean可选项

    如果设置为 true、`yes`、`y`、`true`、`t`、`on` 或 `1`，消息模板将使用 Jinja 模板引擎渲染。

    默认值：none

  • markdown

    boolean可选项

    如果设置为 true、`yes`、`y`、`true`、`t`、`on` 或`1`，模板替换产生的信息将被视为 Markdown 格式，并将渲染为 HTML。

    默认值：none

  • pass_environment

    array可选项

    以逗号分隔的环境变量名称白名单或名称 shell-glob 模式。 只有符合任何给定名称或模式的环境变量 的环境变量才能作为有效的占位符出现在信息模板中。

    默认值：DRONE_*

  • markdown_extensions

    array可选项

    以逗号分隔的已启用 Markdown 扩展名列表。

    默认值：admonition, extra, sane_lists, smarty

  • template

    string可选项

    信息模板。 有效的占位符（例如：`${DRONE_REPO}`）将被替换为与之匹配的环境变量的值。 替换为匹配的环境变量值（根据 根据 `pass_environment` 设置进行过滤）。

    默认值：${DRONE_BUILD_STATUS}