mdomke/concourse-email-resource

Concourse Email Resource 镜像文档

镜像概述和主要用途

Concourse Email Resource 是一个用于Concourse CI平台的资源镜像，专门用于在CI/CD流水线中配置和发送邮件通知。通过该资源，用户可以在流水线作业中集成邮件发送功能，实现构建结果、状态更新等关键信息的及时通知。

核心功能和特性

• 灵活的收件人配置：支持直接指定收件人列表或通过文件读取收件人地址
• 多样化的主题和正文设置：支持通过文件或纯文本指定邮件主题和正文
• 模板渲染支持：集成Jinja模板引擎，可使用模板变量和环境变量动态生成内容
• HTML邮件支持：默认发送HTML格式邮件，支持CSS内联样式
• 纯文本模式：可配置为发送纯文本格式邮件

使用场景和适用范围

适用于Concourse CI流水线中需要发送邮件通知的各类场景，包括但不限于：

• 构建成功/失败通知
• 流水线状态更新通知
• 关键步骤完成提醒
• 错误告警和异常通知

详细使用方法和配置说明

资源类型配置

首先需要将该资源类型添加到项目中：

yaml
resource_types:
- name: email
  type: docker-image
  source:
    repository: mdomke/concourse-email-resource

资源配置

配置邮件发送资源，指定发件人信息：

yaml
resources:
- name: send-email
  type: email
  source:
    from: ci@example.com  # 必填，发件人邮箱地址

发送邮件操作（out）

通过put步骤调用邮件资源发送邮件：

yaml
- put: send-email
  params:
    to: [recipient@example.com]
    subject: subject.txt
    body: body.txt

参数说明

模板使用说明

subject|subject_text和body|body_text支持Jinja模板语法，可使用：

• vars参数指定的JSON文件中的变量
• 所有环境变量（如BUILD_ID、BUILD_PIPELINE_NAME等）

使用模板时，subject_text或body_text需定义为多行文本：

yaml
- put: send-email
  params:
    to: [recipient@example.com]
    subject_text: |
      {% block BUILD_PIPELINE_NAME %}{% endblock %}:{% block BUILD_JOB_NAME %}{% endblock %} 构建失败
    body_text: |
      流水线: {% block BUILD_PIPELINE_NAME %}{% endblock %}
      作业: {% block BUILD_JOB_NAME %}{% endblock %}
      构建ID: {% block BUILD_ID %}{% endblock %}
      构建状态: 失败

高级使用示例

使用模板和变量文件

yaml
- put: send-email
  params:
    to: [recipient@example.com]
    subject: subject  # 包含Jinja模板的主题文件路径
    body: body.html   # 包含Jinja模板的HTML正文文件路径
    vars: vars.json   # 包含模板变量的JSON文件路径

发送纯文本邮件

yaml
- put: send-email
  params:
    to: [recipient@example.com]
    subject: subject.txt  # 纯文本主题文件路径
    body: body.txt        # 纯文本正文文件路径
    type: plain           # 指定为纯文本格式

注意事项

• check和in操作不执行任何实际功能（noop）
• 使用Jinja模板时，确保YAML格式正确，多行文本需使用|符号
• HTML邮件默认启用CSS内联，如需保留外部样式表，可设置inline_css: False