[Workaround] Auto-cancel redundant builds on the default branch

sam1 · May 17, 2024, 7:56pm

This script is really useful. Thanks!!

I added functionality to auto-cancel jobs within the last 10 minutes, otherwise allow them to keep running. If that is interesting to anybody, see

github.com

boostorg/boost/blob/develop/.circleci/autocancel.sh

#!/bin/bash

# Auto-cancel preceding workflows
# https://discuss.circleci.com/t/workaround-auto-cancel-redundant-builds-on-the-default-branch/39468

set -x

## Get the name of the workflow and the related pipeline number
curl --header "Circle-Token: $PERS_API_TOKEN_BOOST_5" --request GET "https://circleci.com/api/v2/workflow/${CIRCLE_WORKFLOW_ID}" -o current_workflow.json
WF_NAME=$(jq -r '.name' current_workflow.json)
CURRENT_PIPELINE_NUM=$(jq -r '.pipeline_number' current_workflow.json)
CURRENT_PIPELINE_CREATED=$(jq -r '.created_at' current_workflow.json)
TIME_THRESHOLD=$(date --utc +'%Y-%m-%dT%TZ' -d "${CURRENT_PIPELINE_CREATED} -10 minutes")

## Get the IDs of pipelines created by the current user on the same branch. (Only consider pipelines that have a pipeline number inferior to the current pipeline)
PIPE_IDS=$(curl --header "Circle-Token: $PERS_API_TOKEN_BOOST_5" --request GET "https://circleci.com/api/v2/project/gh/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME/pipeline?branch=$CIRCLE_BRANCH"|jq -r --argjson CURRENT_PIPELINE_NUM "$CURRENT_PIPELINE_NUM" --arg TIME_THRESHOLD "${TIME_THRESHOLD}" '.items[] | select(.state == "created") | select(.number < $CURRENT_PIPELINE_NUM) | select(.created_at > $TIME_THRESHOLD) | .id')

## Get the IDs of currently running/on_hold workflows that have the same name as the current workflow, in all previously created pipelines.
if [ ! -z "$PIPE_IDS" ]; then
  for PIPE_ID in $PIPE_IDS

This file has been truncated. show original

Topic		Replies	Views
Workaround to cancel redundant builds Tips, Tricks, and Hacks	1	2123	October 23, 2018
A simple fix for redundant build cancellation in workflows Tips, Tricks, and Hacks workflow	2	1778	August 27, 2018
Redundant builds are canceled on the default branch Feedback & Bug Reports	3	1785	November 20, 2020
Cancel Builds En Masse Integrations and Accounts	4	936	May 17, 2019
Prevent workflow cancellation when triggering pipeline via. REST API Pipelines 2.0	2	2175	June 10, 2021

[Workaround] Auto-cancel redundant builds on the default branch

Related topics