在 Jenkins 中配置邮件通知可以帮助团队成员及时了解构建状态和项目进展情况,以下是详细的配置步骤:
安装 Email Extension 插件
- 登录 Jenkins 管理界面,点击“系统管理” -> “插件管理”。
- 在“可选插件”标签页中,搜索“Email Extension Plugin”,勾选该插件后点击“直接安装”按钮。等待插件安装完成后,重启 Jenkins 使插件生效。
配置邮件服务器
- 再次进入“系统管理” -> “系统设置”页面,找到“邮件通知”或“Extended E-mail Notification”(取决于安装的插件版本)部分。
- 在“SMTP server”字段中填写邮件服务器的地址,如 smtp.example.com 。
- 在“Default user e-mail suffix”字段中填写默认的邮箱后缀,例如 @example.com ,这将在发送邮件时自动补全发件人的邮箱地址。
- 输入“用户名”和“密码”,用于登录邮件服务器。如果使用的是 Gmail 等需要开启特定权限的邮箱,还需要按照邮箱服务提供商的要求进行相应的设置,如开启“允许不太安全的应用”等选项。
- 在“SMTP port”字段中填写邮件服务器的端口号,常见的有 25、465、587 等,根据邮件服务器的配置进行填写。
- 选择“Use SSL”或“Use TLS”选项,根据邮件服务器是否要求加密连接来确定。例如,Gmail 通常要求使用 TLS 加密连接,此时应勾选“Use TLS”。
- 点击“Test configuration”按钮,输入一个有效的收件人邮箱地址,点击“Send Test e-mail”进行测试。如果配置正确,收件人将收到一封测试邮件,表明邮件服务器配置成功。
配置项目的邮件通知
- 进入具体的项目配置页面,点击“配置”。
- 在“构建后操作”部分,点击“增加构建后操作步骤”,选择“Editable Email Notification”。
- 在“Project Recipient List”字段中填写收件人的邮箱地址,可以使用逗号分隔多个邮箱。也可以使用变量来动态指定收件人,如
$BUILD_USER_EMAIL
表示触发构建的用户的邮箱地址。 - 在“Subject”字段中填写邮件的主题,例如“[${PROJECT_NAME}] Build #${BUILD_NUMBER} - ${BUILD_STATUS}”,其中
${PROJECT_NAME}
、${BUILD_NUMBER}
和${BUILD_STATUS}
等都是 Jenkins 提供的变量,分别表示项目名称、构建编号和构建状态,这样邮件主题将根据每次构建的实际情况动态生成。 - 在“Content”字段中填写邮件的内容,可以使用 HTML 或纯文本格式。同样可以使用 Jenkins 变量来动态显示构建信息,如“Build Number: ${BUILD_NUMBER}
Build Status: ${BUILD_STATUS}
Build Log: ${BUILD_URL}consol”,这将在邮件中显示构建编号、构建状态和构建日志的链接。 - 根据需要配置其他选项,如“Attachments”可以添加附件,“Triggers”可以设置在何种构建状态下触发邮件通知,如构建失败、构建不稳定等。
保存配置并测试
- 完成上述配置后,点击页面底部的“保存”按钮保存项目的邮件通知配置。
- 手动触发一次构建,等待构建完成后,检查收件人是否收到了相应的邮件通知,并且邮件内容和格式是否符合预期。如果没有收到邮件或邮件内容不正确,可以检查 Jenkins 的系统日志和邮件服务器的日志,查找可能的错误信息并进行相应的调整。