sinlov/woodpecker-feishu-group-robot

woodpecker-feishu-group-robot

镜像概述和主要用途

作为Woodpecker CI的插件，用于在CI/CD流程中向飞书群实时发送构建状态通知，帮助团队及时掌握构建结果。支持自定义通知规则、飞书安全验证及多语言消息，适配多种Docker平台，简化持续集成流程中的消息通知环节。

核心功能和特性

• 易于设置和使用，快速集成到Woodpecker CI流程
• 支持忽略同步骤构建成功通知，仅在上次构建失败后发送比较通知
• 国际化支持：en-US、zh-CN等（v1.4.0+版本，更多语言支持见--help）
• 多Docker平台支持：linux/amd64、linux/386、linux/arm64/v8、linux/arm/v7、linux/ppc64le、linux/s390x（v1.4.0+版本）

使用前准备

1. 参考https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN?lang=en-US%E5%88%9B%E5%BB%BA%E7%BE%A4%E6%9C%BA%E5%99%A8%E4%BA%BA
2. 配置webhook，格式为https://open.feishu.cn/open-apis/bot/v2/hook/{web_hook}，其中{web_hook}需通过settings.feishu-webhook或PLUGIN_FEISHU_WEBHOOK设置
3. 飞书安全设置：
   • 若启用“自定义关键词”，可通过settings.feishu-msg-title或PLUGIN_FEISHU_MSG_TITLE修改通知标题（需包含关键词）
   • 若启用“签名验证”，需通过settings.feishu-secret或PLUGIN_FEISHU_SECRET配置密钥
4. 在.gitignore中添加.woodpecker_kit.steps.transfer文件

配置参数

基础配置

自定义配置

隐藏配置

使用示例

Docker后端工作流

yml
labels:
  backend: docker
steps:
  notification-feishu-group-robot:
    image: docker.xuanyuan.run/sinlov/woodpecker-feishu-group-robot:latest
    pull: false
    settings:
      # debug: true # 插件调试开关
      # feishu-enable-debug-notice: true 调试模式下发送通知（需开启debug）
      # feishu-ntp-target: "pool.ntp.org" # 同步NTP时间（可选）
      feishu-webhook:
        # 参考https://woodpecker-ci.org/docs/usage/secrets
        from_secret: feishu_group_bot_token
      feishu-secret:
        from_secret: feishu_group_secret_bot
      feishu-msg-i18n-lang: en-US # 支持en-US、zh-CN等（v1.4.0+版本）
      feishu-msg-title: "CI Notification" # 默认标题
      # 启用转发功能显示更多信息
      feishu-enable-forward: true
      feishu-status-success-ignore: false # 不忽略成功状态通知
      feishu-status-change-success: false # 不单独发送状态变更通知
    when:
      status: # 触发通知的构建状态（仅支持failure/success，两者都设置则发送所有状态通知）
        - failure
        - success

Local后端工作流

需先在本地安装并确保可执行文件在环境变量PATH中：

bash
# 安装最新版本
go install -a github.com/woodpecker-kit/woodpecker-feishu-group-robot/cmd/woodpecker-feishu-group-robot@latest

# 安装指定版本（如v1.0.0）
go install -v github.com/woodpecker-kit/woodpecker-feishu-group-robot/cmd/woodpecker-feishu-group-robot@v1.0.0

工作流配置：

yml
labels:
  backend: local
steps:
  notification-feishu-group-robot:
    image: docker.xuanyuan.run/woodpecker-feishu-group-robot
    settings:
      feishu-webhook:
        from_secret: feishu_group_bot_token
      feishu-secret:
        from_secret: feishu_group_secret_bot
      feishu-msg-i18n-lang: zh-CN
      feishu-msg-title: "CI构建通知"
      feishu-enable-forward: true
    when:
      status:
        - failure
        - success

步骤传输示例（集成file_browser）

支持与woodpecker-file-browser-upload插件联动（v1.5.0+版本），在通知中显示文件上传信息：

yml
labels:
  backend: docker
steps:
  woodpecker-file-browser-upload:
    image: sinlov/woodpecker-file-browser-upload:latest
    pull: false
    settings:
      file-browser-host: "[***]" # file_browser主机地址
      file-browser-username:
        from_secret: file_browser_user_name
      file-browser-user-password:
        from_secret: file_browser_user_passwd
      file-browser-remote-root-path: dist/ # 远程基础路径
      file-browser-dist-type: git # 分发类型（git/custom）
      file-browser-file-glob: # 上传文件匹配模式
        - "**/*.tar.gz"
        - "**/*.sha256"

  notification-feishu-group-robot:
    image: sinlov/woodpecker-feishu-group-robot:latest
    pull: false
    depends_on:
      - woodpecker-file-browser-upload # 依赖文件上传步骤
    settings:
      feishu-webhook:
        from_secret: feishu_group_bot_token
      feishu-secret:
        from_secret: feishu_group_secret_bot
      feishu-msg-title: "CI构建通知"
      feishu-enable-forward: true
      feishu-notice-types:
        - file_browser # 显示file_browser上传信息
        - build_status # 显示构建状态
    when:
      status:
        - failure
        - success