plugins/webhook

drone-webhook 镜像文档

概述

drone-webhook是Drone CI的官方插件，用于在CI/CD流水线中发送HTTP/HTTPS请求，实现与外部系统的集成和事件通知。该镜像由https://github.com/drone-plugins/drone-webhook项目维护，并通过Drone CI自动构建和推送。

核心功能与特性

• HTTP请求支持：支持发送HTTP和HTTPS协议的Webhook请求
• 方法自定义：可配置HTTP请求方法（GET、POST、PUT等）
• 请求头配置：支持自定义请求头（Headers）
• 请求体定制：支持自定义请求体内容
• Drone集成：与Drone CI流水线无缝集成，可作为步骤嵌入构建流程

使用场景

• CI/CD流程事件通知（如构建成功/失败通知）
• 触发外部系统操作（如部署流程、测试环境更新）
• 第三方服务集成（如通知Slack、Microsoft Teams、企业内部系统等）
• 自动化工作流触发（如代码合并后触发下游系统同步）

使用方法

基本用法（Docker Run）

bash
docker run --rm \
  -e PLUGIN_URL="https://example.com/webhook" \
  -e PLUGIN_METHOD="POST" \
  -e PLUGIN_HEADERS="Content-Type:application/json" \
  -e PLUGIN_BODY='{"status":"success","build":"123"}' \
  docker.xuanyuan.run/plugins/webhook

环境变量配置

Drone CI配置示例

在Drone流水线配置文件（.drone.yml）中使用：

yaml
kind: pipeline
type: docker
name: default

steps:
- name: send-webhook
  image: docker.xuanyuan.run/plugins/webhook
  settings:
    url: https://example.com/webhook
    method: POST
    headers:
      Content-Type: application/json
      Authorization: Bearer ${TOKEN}
    body: |
      {
        "repo": "${DRONE_REPO}",
        "build": "${DRONE_BUILD_NUMBER}",
        "status": "${DRONE_BUILD_STATUS}"
      }
    skip_verify: false
    timeout: 15

注意事项

• 敏感信息（如令牌、密钥）建议通过Drone Secrets管理，避免明文配置
• 确保目标Webhook服务可从Drone Runner访问
• 复杂请求体建议使用文件挂载或环境变量注入的方式提供