navicore/teams-notification-resource

Concourse CI Teams Resource 镜像文档

镜像概述

Concourse CI Teams Resource是一个Concourse CI资源，用于从Concourse CI流水线内向Microsoft Teams发送消息。该镜像实现了Microsoft Teams Connector协议和Concourse CI resource协议，支持在消息中解析Concourse CI环境变量。

!teams

核心功能与特性

• Teams消息发送：通过Teams Incoming Webhook向指定频道发送通知消息
• 环境变量解析：运行时自动解析Concourse CI环境变量，如：

  $BUILD_ID
  $BUILD_NAME
  $BUILD_JOB_NAME
  $BUILD_PIPELINE_NAME
  $BUILD_TEAM_NAME
  $ATC_EXTERNAL_URL
  

• Markdown支持：消息文本支持Markdown格式
• 可配置消息参数：支持自定义标题、颜色、操作按钮等

状态：Alpha质量，已满足基本使用需求
待办：使potentialAction按钮/链接可配置为可选

使用场景与适用范围

适用于需要在Concourse CI流水线中向Microsoft Teams频道发送通知的场景，例如：

• 构建成功/失败通知
• 拉取请求(PR)测试结果通知
• 流水线关键节点状态更新
• 部署完成通知

使用方法与配置说明

1. 前置设置（Teams Webhook配置）

1. 打开Microsoft Teams界面
2. 选择要接收通知的频道（如#devops）
3. 打开频道的"更多选项"菜单，选择"Connectors"
   !connector
4. 选择"Incoming Webhook"，按提示设置连接器名称、图标等信息
   !webhook
5. 保存并获取Webhook URL，用于后续流水线配置

2. 资源类型定义

在Concourse pipeline配置中定义资源类型：

yaml
resource_types:
- name: teams-notification
  type: docker-image
  source:
    repository: navicore/teams-notification-resource
    tag: latest

3. 资源配置

定义Teams通知资源，需指定Teams Webhook URL：

yaml
resources:
- name: alert
  type: teams-notification
  source:
    url: https://outlook.office365.com/webhook/blah-blah-blah  # 替换为实际Webhook URL

Source参数说明：

• url：必填，Teams Incoming Webhook URL，格式通常为https://outlook.office365.com/webhook/XXX

4. 参数配置（在任务中使用）

在流水线任务中通过put操作发送通知，支持以下参数：

5. 流水线示例

!pipeline

以下是拉取请求测试任务的通知配置示例：

yaml
- name: Test-Pull-Request
  plan:
  - get: {{mypipeline}}-pull-request
    trigger: true
  - task: test-pr
    file: {{mypipeline}}-pull-request/pipeline/test-pr.yml
    on_success:
      put: alert
      params:
        text: |
          拉取请求测试：无错误
        title: {{mypipeline}} 拉取请求已测试
        actionName: {{mypipeline}} 流水线
        actionTarget: $ATC_EXTERNAL_URL/teams/$BUILD_TEAM_NAME/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME
    on_failure:
      put: alert
      params:
        color: EA4300
        text: |
          拉取请求测试：**存在错误**
        title: {{mypipeline}} 拉取请求测试失败
        actionName: {{mypipeline}} 流水线
        actionTarget: $ATC_EXTERNAL_URL/teams/$BUILD_TEAM_NAME/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME