如何中断Webhook触发的重复GitLab流水线？

我完全理解你的痛点——Webhook多次触发导致流水线重复运行，耗时又浪费资源，而官方的自动取消功能只针对提交推送场景确实很头疼。这里有个可靠的解决方案，通过GitLab API在流水线启动时自动取消同来源的旧流水线，确保只有最后一次触发的流水线能完整执行：

核心思路 #

在流水线的首个任务中，调用GitLab API查询当前项目中所有由Webhook触发、且处于运行中/待处理状态的流水线，排除当前流水线后，批量取消这些旧流水线。这样就能保证每次只有最新的流水线继续运行。

具体实现步骤 #

1. 创建GitLab API令牌 #

• 进入你的GitLab项目，依次点击「设置」→「访问令牌」
• 创建一个项目级令牌，勾选api和read_repository权限，设置过期时间后保存
• 在项目「设置」→「CI/CD」→「变量」中添加变量GITLAB_API_TOKEN，勾选「Masked」和「Protected」选项，把刚才生成的令牌值填进去

2. 在CI配置中添加取消旧流水线的任务 #

在你的.gitlab-ci.yml最顶部添加一个前置任务，确保它在所有其他任务之前执行：

cancel-previous-webhook-pipelines:
  stage: .pre
  image: alpine:latest
  interruptible: true
  before_script:
    - apk add --no-cache curl jq
  script:
    # 获取所有Webhook触发的、非当前的运行中/待处理流水线ID
    - |
      PREVIOUS_PIPELINES=$(curl --silent --header "PRIVATE-TOKEN: $GITLAB_API_TOKEN" \
        "$CI_API_V4_URL/projects/$CI_PROJECT_ID/pipelines?status=running&status=pending&source=webhook" \
        | jq -r '.[] | select(.id != '$CI_PIPELINE_ID') | .id')
    # 循环取消这些流水线
    - |
      if [ -n "$PREVIOUS_PIPELINES" ]; then
        echo "Found $(echo "$PREVIOUS_PIPELINES" | wc -l) previous webhook pipelines to cancel:"
        for PIPELINE_ID in $PREVIOUS_PIPELINES; do
          echo "Canceling pipeline #$PIPELINE_ID..."
          curl --silent --request POST --header "PRIVATE-TOKEN: $GITLAB_API_TOKEN" \
            "$CI_API_V4_URL/projects/$CI_PROJECT_ID/pipelines/$PIPELINE_ID/cancel"
        done
      else
        echo "No previous webhook pipelines to cancel."
      fi
  only:
    - webhooks # 只在Webhook触发时执行这个任务

3. 配置主任务为可中断 #

确保你的静态站点生成任务设置interruptible: true，这样如果它被新流水线中断时能快速停止：

build-static-site:
  stage: build
  interruptible: true
  script:
    - # 你的静态站点生成命令
  only:
    - webhooks

补充说明 #

• 这个方案依赖jq工具来解析API返回的JSON，我们在before_script里用Alpine的包管理器安装了它，如果你用的是其他镜像，可能需要调整安装命令
• CI_API_V4_URL和CI_PROJECT_ID是GitLab CI自动提供的预定义变量，不需要手动配置
• 如果你的Webhook有特定的触发场景（比如来自某个外部系统），也可以让外部系统在触发新流水线前先调用API取消旧流水线，这样能进一步减少不必要的任务启动

这样配置后，每次Webhook触发新流水线时，都会自动把之前还在运行或待处理的同来源流水线取消，确保只有最后一次触发的流水线完成静态站点生成任务。

内容的提问来源于stack exchange，提问作者Laurens Kling