Jenkins脚本如何发送构建报告邮件

wen 实用脚本 2026-07-14 3

Jenkins脚本发送构建报告邮件：从入门到精通

目录导读

为什么需要自动化构建报告邮件？
Jenkins邮件通知的核心机制
关键配置：SMTP服务器与系统管理员邮箱
基础脚本：Jenkins Pipeline中发送邮件的两种方式
进阶技巧：定制HTML报告、附件与失败告警
常见问题与解答（FAQ）
总结与最佳实践

为什么需要自动化构建报告邮件？

在持续集成/持续部署（CI/CD）流程中，构建结果（成功、失败、不稳定）需要及时推送给团队，手动检查Jenkins控制台不仅低效，还容易遗漏关键故障，通过脚本自动发送邮件,可以实现：

Jenkins脚本如何发送构建报告邮件

实时通知：CI/CD流程完成后秒级推送,减少响应时间。
统一格式：用HTML表格、图表清晰展示测试覆盖率、代码质量指标。
精准触达：针对失败构建仅通知相关开发者,避免信息轰炸。

问：发送邮件是否必须依赖插件？
答：不完全，虽然Jenkins有内置“邮件通知”插件，但使用Pipeline脚本可以实现更精细的控制（如动态收件人、自定义附件）,具体取决于你的Jenkins版本和插件安装情况。

Jenkins邮件通知的核心机制

Jenkins通过SMTP协议发送邮件,你需要提供：

SMTP服务器地址（如 smtp.gmail.com、公司内部服务器的IP或域名）
端口（默认25，加密常用587或465）
认证凭据（用户名/密码或API Token）
发件人地址（即系统管理员邮箱）

这些参数通常在 系统管理 -> 系统配置 -> Extended E-mail Notification（如果安装了Email Extension插件）或 邮件通知 中全局配置。

问：如果公司邮件服务器要求SSL/TLS怎么办？
答：在Jenkins全局配置中勾选“使用SSL”并填写对应端口（如465），若支持STARTTLS，选端口587并勾选“使用TLS”，推荐用Email Extension插件,它支持更丰富的设置。

基础脚本：Jenkins Pipeline中发送邮件的两种方式

方式1：使用内置“mail”步骤（适用于Declarative Pipeline）

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building the project...'
            }
        }
    }
    post {
        success {
            mail to: 'team@example.com, lead@example.com',
                 subject: "构建成功: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                 body: "构建成功，查看详情: ${env.BUILD_URL}"
        }
        failure {
            mail to: 'team@example.com',
                 subject: "构建失败: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                 body: "构建失败，请立即检查，日志: ${env.BUILD_URL}console"
        }
    }
}

方式2：使用Email Extension插件（更推荐）

先安装插件 Email Extension Plugin，

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building...'
            }
        }
    }
    post {
        success {
            emailext (
                to: 'list@example.com',
                subject: "SUCCESS: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                body: '构建成功，请查看测试报告附件。',
                attachmentsPattern: '**/test-results/**/*.xml'
            )
        }
        failure {
            emailext (
                to: 'dev-team@example.com',
                subject: "FAILURE: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
                body: "构建失败，详细日志：${env.BUILD_URL}console",
                mimeType: 'text/html',
                recipientProviders: [culprits(), developers()] // 仅发给最近提交的人
            )
        }
    }
}

问：两个方式哪个更好？
答：如果只需要简单成功/失败通知，用内置mail步骤即可，若需要动态收件人、附件、HTML模板，必须用emailext，后者支持更多变量如${BUILD_LOG_EXCERPT}、自定义CSS。

进阶技巧：定制HTML报告、附件与失败告警

发送HTML格式报告，包含测试结果

def reportContent = """
<html>
<body>
<h2>构建报告 #${env.BUILD_NUMBER}</h2>
<p>状态: <b style="color:green">SUCCESS</b></p>
<table border="1">
<tr><th>模块</th><th>测试通过</th><th>失败</th></tr>
<tr><td>Auth</td><td>45</td><td>0</td></tr>
<tr><td>API</td><td>120</td><td>2</td></tr>
</table>
<p>完整日志: <a href="${env.BUILD_URL}">${env.BUILD_URL}</a></p>
</body>
</html>
"""
emailext (
    to: 'qa@example.com',
    subject: "Test Report - Build #${env.BUILD_NUMBER}",
    mimeType: 'text/html',
    body: reportContent
)

附加Zip压缩的构建产物

archiveArtifacts artifacts: '**/target/*.jar'
emailext (
    to: 'archive@example.com',
    subject: "Build Artifacts #${env.BUILD_NUMBER}",
    attachmentsPattern: '**/target/*.jar'
)

在构建失败时@指定负责人（需要配合插件）

使用emailext的recipientProviders参数，可自动提取Git提交者、构建触发者或上一构建中的“culprits”（失败责任人）。

emailext (
    to: 'admin@example.com',
    subject: "Failed Build",
    recipientProviders: [requestor(), developers(), culprits()],
    body: "责任人请查看构建日志。"
)

问：如何实现仅失败时发送邮件，成功时跳过？
答：在post块中使用条件判断即可，如上文示例中success {}和failure {}区块自动区分结果，或者用when指令在Stage级别控制。

常见问题与解答（FAQ）

Q1：邮件发送成功但收件人没收到？
A：检查SMTP服务器是否允许转发、发件人地址是否在白名单、邮件是否被收件方标记为垃圾，另可用 mail 步骤设置 replyTo 参数。

Q2：如何包含GIT提交哈希或变更日志？
A：使用环境变量 env.GIT_COMMIT、env.GIT_BRANCH，或用 sh 'git log --oneline -5' 生成日志字符串。

Q3：能否在邮件中嵌入截图或性能报告图？
A：可以，将图片上传为构建产物，然后用 <img src="data:image/png;base64,..."> 或直接引用Jenkins中静态文件的URL（需要开启“匿名读取”权限）,但更稳妥的做法是附加上PDF或图片附件。

Q4：邮件内容过长，导致被截断？
A：适当使用附件（如日志文件），Email Extension插件支持compressLog和logLevel参数控制日志摘要。

总结与最佳实践

全局配置优先：在系统设置中统一配置SMTP、默认发件人,避免在每个Pipeline中重复。
使用Email Extension插件：它提供了emailext步骤，支持HTML模板、动态收件人、附件和失败责任人。
敏感信息保密：邮件服务器密码不要硬编码在脚本中，使用Jenkins凭据绑定（credentials ID）。
避免邮件轰炸：在post块中建立合理的逻辑，例如只在失败或第一次失败时发送,或设置静默期。
测试先行：先在独立的测试Pipeline中用echo验证变量是否正常,再启用邮件发送。

通过上述方法，你可以用Jenkins Pipeline脚本高效地将构建报告发送到团队邮箱，提升CI/CD流程的可视化和协作效率。