sinlov/drone-feishu-robot-oss

sinlov/drone-feishu-robot-oss 镜像文档

镜像概述

sinlov/drone-feishu-robot-oss 是一个 Drone CI 插件，用于在 CI/CD 流水线中向飞书（Feishu）机器人发送构建状态通知。该插件可根据构建事件（如推送、拉取请求、标签等）和状态（失败/成功）触发通知，并支持自定义通知标题、超时控制及 NTP 时间同步等功能。

核心功能与特性

• 多事件触发：支持 promote、rollback、push、pull_request、tag 等 Drone 事件触发通知
• 状态过滤：可指定仅在构建失败或成功时发送通知
• 自定义配置：支持自定义通知标题、超时时间、NTP 时间同步目标
• 安全集成：通过 Drone Secrets 管理飞书机器人的 Webhook 和密钥，避免明文暴露
• 构建状态优化：支持通过 Drone 系统管理员令牌忽略最近成功构建，仅通知状态变化

使用场景

适用于使用 Drone CI 进行持续集成/持续部署的团队，需要将构建结果实时通知到飞书群组，以便团队成员及时了解构建状态，快速响应失败情况。

使用方法与配置说明

基本配置（.drone.yml）

以下是 1.x 版本的典型配置示例：

yaml
steps:
  - name: notify-failure-feishu-robot
    image: docker.xuanyuan.run/sinlov/drone-feishu-robot-oss:latest
    settings:
      # debug: true  # 插件调试开关，可选
      # ntp_target: "pool.ntp.org"  # NTP 时间同步目标，不设置则不同步，可选
      # timeout_second: 10  # 超时时间（秒），默认 10，可选
      feishu_webhook:
        from_secret: feishu_group_bot_token  # 飞书机器人 Webhook 地址，从 Drone Secrets 获取
      feishu_secret:
        from_secret: feishu_group_secret_bot  # 飞书机器人密钥，从 Drone Secrets 获取
      feishu_msg_title: "Drone CI Notification"  # 通知标题，默认 "[Drone CI Notification]"，可选
      feishu_enable_forward: true  # 允许通知卡片展示更多信息，可选
      drone_system_admin_token:  # Drone 系统管理员令牌（1.5.0+ 支持），用于忽略最近成功构建，可选
        from_secret: drone_system_admin_token
      # 忽略最近成功构建的距离（1 表示忽略上一次成功构建，仅通知状态变化；0 表示不忽略）
      feishu_ignore_last_success_by_admin_token_distance: 1
    when:
      event:  # 触发通知的事件类型
        - promote
        - rollback
        - push
        - pull_request
        - tag
      status:  # 触发通知的构建状态（仅支持 failure/success，同时开启则所有状态均通知）
        - failure
        # - success

配置参数说明

触发条件配置（when 字段）

• event：指定触发通知的 Drone 事件类型，可选值包括 promote、rollback、push、pull_request、tag 等
• status：指定触发通知的构建状态，可选值为 failure（失败）或 success（成功），同时配置则所有状态均触发通知

注意事项

• 飞书机器人的 Webhook 和密钥需通过 Drone Secrets 管理，避免在配置文件中明文暴露
• drone_system_admin_token 需要 Drone 管理员权限，用于获取构建历史，实现忽略最近成功构建的功能
• 通知卡片样式可参考 https://open.feishu.cn/document/ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN 进行自定义优化