deblan/woodpecker-email

woodpecker-email-php

镜像概述

woodpecker-email-php是Woodpecker-CI的专用插件，旨在通过电子邮件方式发送CI/CD流水线的构建状态通知。该插件能够捕获构建过程中的成功、失败、取消等状态信息，并将详细报告发送给指定收件人，帮助开发团队实时掌握构建结果。

核心功能和特性

• 多状态通知：支持构建成功、失败、取消等多种状态的邮件通知
• 自定义邮件内容：可配置邮件主题和正文模板，支持嵌入构建相关动态变量（如构建编号、提交信息等）
• 灵活的收件人设置：支持指定单个或多个收件人***，满足团队协作需求
• SMTP兼容性：兼容主流SMTP邮件服务器，支持TLS/SSL加密和身份认证

使用场景

• 开发团队需要实时了解CI/CD流水线构建结果时
• 构建失败需及时通知开发人员进行问题修复时
• 需要向项目管理人员同步构建状态时
• 自动化部署流程中需在构建完成后触发后续操作通知时

使用方法和配置说明

前提条件

• 已部署Woodpecker-CI服务
• 拥有可访问的SMTP邮件服务器（需提供服务器地址、端口、认证信息）

基本配置（Woodpecker Pipeline）

在Woodpecker流水线配置文件（如.woodpecker.yml）中添加以下步骤：

yaml
steps:
  notify:
    image: deblan/woodpecker-email-php
    settings:
      # SMTP服务器配置
      smtp_host: smtp.example.com
      smtp_port: 587
      smtp_username: ci@example.com
      smtp_password: your-smtp-password
      smtp_encryption: tls
      
      # 邮件内容配置
      from: ci@example.com
      to: developer@example.com, manager@example.com
      subject: "构建{{ build.status }}: {{ repo.name }} #{{ build.number }}"
      body: |
        构建状态: {{ build.status }}
        项目名称: {{ repo.name }}
        构建编号: {{ build.number }}
        提交SHA: {{ commit.sha }}
        分支: {{ commit.branch }}
        提交作者: {{ commit.author }}
        构建链接: {{ build.link }}

配置参数说明

内置变量说明

支持以下动态变量嵌入邮件内容：

• {{ build.status }}: 构建状态（success/failure/canceled等）
• {{ build.number }}: 构建编号
• {{ build.link }}: 构建详情页链接
• {{ repo.name }}: 代码仓库名称
• {{ commit.sha }}: 提交的SHA哈希值
• {{ commit.branch }}: 提交所在分支
• {{ commit.author }}: 提交作者
• {{ commit.message }}: 提交信息

更多配置选项

完整配置说明和高级用法，请参考官方文档：woodpecker-email-php 官方文档