sponomarev/circleci-cancel-builds

用于取消CircleCI 2.0冗余构建的极简Docker镜像

遗憾的是，CircleCI 2.0工作流不像1.0版本那样支持取消冗余构建。当你过于频繁地推送代码时，整个CI工作流可能会被卡住，直到所有之前的任务完成。

工作原理

• 容器内的脚本通过内置的https://circleci.com/docs/2.0/env-vars/#circleci-built-in-environment-variables%E8%AF%86%E5%88%AB%E4%BB%93%E5%BA%93%E3%80%81%E5%BD%93%E5%89%8D%E5%88%86%E6%94%AF%E5%92%8C%E6%9E%84%E5%BB%BA%E7%BC%96%E5%8F%B7
• 获取当前分支下正在运行或排队的构建列表
• 从候选列表中排除当前构建
• 逐个取消冗余构建

配置说明

Docker镜像已在https://hub.docker.com/r/sponomarev/circleci-cancel-builds/%E6%8F%90%E4%BE%9B%EF%BC%8C%E9%85%8D%E7%BD%AE%E6%AD%A5%E9%AA%A4%E5%A6%82%E4%B8%8B%EF%BC%9A

1. 通过你的https://circleci.com/account/api%E7%94%9F%E6%88%90CircleCI API令牌
2. 将令牌作为CIRCLE_TOKEN环境变量添加到https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-project%E4%B8%AD
3. 在构建工作流中添加一个使用sponomarev/circleci-cancel-builds镜像的独立任务作为必需的第一步
4. 调用run命令

示例配置：

yml
version: 2

workflows:
  version: 2
  build_and_test:
    jobs:
      - cancel_redundant_builds
      - checkout:
          requires:
            - cancel_redundant_builds

jobs:
  cancel_redundant_builds:
    docker:
      - image: sponomarev/circleci-cancel-builds
    steps:
      - run:
          name: 取消冗余构建
          command: run

限制

这个解决方案并非完美——它需要工作流启动并调用取消任务，获取已发布的容器可能需要一些时间，但总比没有好。遗憾的是，CircleCI API目前没有提供直接控制工作流的方式。

致谢

特别感谢CircleCI论坛的https://discuss.circleci.com/u/lumberj%EF%BC%8C%E4%BB%96%E6%8F%90%E4%BE%9B%E4%BA%86%E4%BD%BF%E7%94%A8API%E6%96%B9%E6%B3%95%E5%8F%96%E6%B6%88%E6%9E%84%E5%BB%BA%E7%9A%84%E6%80%9D%E8%B7%AF%E3%80%82

许可证

代码以开源形式发布，遵循http://opensource.org/licenses/MIT%E6%9D%A1%E6%AC%BE%E3%80%82