流水线插件 plugins

流水线任务插件plugins:流水线任务消息通知可以通过配置 plugins 实现钉钉、企业微信、飞书等渠道的消息通知。

示例

以下为一个钉钉任务通知插件的配置示例:

stages:
  build_stage:
    name: 构建阶段
    jobs:
      build_job: 
        name: 构建任务
        runsOn: public/cn-beijing
        steps:
          ......
        plugins:
          - name: 钉钉机器人通知插件
            plugin: DingTalkPlugin
            triggerState:
              - success
              - fail
            with:
              webhook: <ding-talk-webhook-url>
              noticeContent:
                - pipelineName
                - operator
                - pipelineTask
                - pipelineStage
                - status
              customContent: <DIY-message>
              at: <mobile-phone>

详细说明

stages.<stage_id>.jobs.<job_id>.plugins

流水线任务插件,支持配置一个或多个任务插件。

stages.<stage_id>.jobs.<job_id>.plugins[].name

必填。流水线步骤的展示名称。长度限制 30 个字符。

stages.<stage_id>.jobs.<job_id>.plugins[].plugin

  • 必填。选择具体使用任务插件,目前支持的 plugin 包括:

    • DingTalkPlugin

    • WechatPlugin

    • FeishuPlugin

    • EmailPlugin

    • WebhookPlugin

  • 具体查看配置 Flow 的 plugins 清单。

stages.<stage_id>.jobs.<job_id>.plugins[].triggerState

必填。选择任务插件触发状态,当该流水线的任务进入选择状态后,会触发消息通知,目前支持的状态包括:

  • 成功:success

  • 失败:fail

  • 取消:cancel

  • 跳过:skip

  • 等待执行:wait

stages.<stage_id>.jobs.<job_id>.plugins[].with

必填。填写流水线任务插件的参数,具体查看配置 Flow 的 plugins 详细说明。