From ca050053bf2758467f4f17d601d939c89fb24c9d Mon Sep 17 00:00:00 2001
From: Jimmy Chen <jchen.tc@gmail.com>
Date: Mon, 14 Aug 2023 03:16:03 +0000
Subject: [PATCH] Use the native `concurrency` property to cancel workflows
 (#4572)

I noticed that some of our workflows aren't getting cancelled when a new one has been triggered, so we ended up having a long queue in our CI when multiple changes are triggered in a short period.

Looking at the comment here, I noticed the list of workflow IDs are outdated and no longer exist, and some new ones are missing:
https://github.com/sigp/lighthouse/blob/dfcb3363c757671eb19d5f8e519b4b94ac74677a/.github/workflows/cancel-previous-runs.yml#L12-L13

I attempted to update these, and came across this comment on the [`cancel-workflow-action`](https://github.com/styfle/cancel-workflow-action) repo:
> You probably don't need to install this custom action.
>
> Instead, use the native [concurrency](https://github.blog/changelog/2021-04-19-github-actions-limit-workflow-run-or-job-concurrency/) property to cancel workflows, for example:

So I thought instead of updating the workflow and maintaining the workflow IDs, perhaps we can try experimenting the [native `concurrency` property](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency).
---
 .github/workflows/book.yml                 |  4 ++++
 .github/workflows/cancel-previous-runs.yml | 14 --------------
 .github/workflows/docker-antithesis.yml    |  4 ++++
 .github/workflows/docker.yml               |  4 ++++
 .github/workflows/linkcheck.yml            |  4 ++++
 .github/workflows/local-testnet.yml        |  4 ++++
 .github/workflows/release.yml              |  4 ++++
 .github/workflows/test-suite.yml           |  5 +++++
 8 files changed, 29 insertions(+), 14 deletions(-)
 delete mode 100644 .github/workflows/cancel-previous-runs.yml

diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml
index 598754368e9..db458a3dbfd 100644
--- a/.github/workflows/book.yml
+++ b/.github/workflows/book.yml
@@ -5,6 +5,10 @@ on:
     branches:
       - unstable
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build-and-upload-to-s3:
     runs-on: ubuntu-20.04
diff --git a/.github/workflows/cancel-previous-runs.yml b/.github/workflows/cancel-previous-runs.yml
deleted file mode 100644
index 2eaefa40ca0..00000000000
--- a/.github/workflows/cancel-previous-runs.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-name: cancel previous runs
-on: [push]
-jobs:
-  cancel:
-    name: 'Cancel Previous Runs'
-    runs-on: ubuntu-latest
-    timeout-minutes: 3
-    steps:
-      # https://github.com/styfle/cancel-workflow-action/releases
-      - uses: styfle/cancel-workflow-action@514c783324374c6940d1b92bfb962d0763d22de3 # 0.7.0
-        with:
-          # https://api.github.com/repos/sigp/lighthouse/actions/workflows
-          workflow_id: 697364,2434944,4462424,308241,2883401,316
-          access_token: ${{ github.token }}
diff --git a/.github/workflows/docker-antithesis.yml b/.github/workflows/docker-antithesis.yml
index 84f5541a3cc..a96431fafbd 100644
--- a/.github/workflows/docker-antithesis.yml
+++ b/.github/workflows/docker-antithesis.yml
@@ -5,6 +5,10 @@ on:
         branches:
             - unstable
 
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
 env:
     ANTITHESIS_PASSWORD: ${{ secrets.ANTITHESIS_PASSWORD }}
     ANTITHESIS_USERNAME: ${{ secrets.ANTITHESIS_USERNAME }}
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index c3119db3780..21ca4940d9c 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -8,6 +8,10 @@ on:
         tags:
             - v*
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 env:
     DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
     DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
index 8428c0a3b0a..19236691f63 100644
--- a/.github/workflows/linkcheck.yml
+++ b/.github/workflows/linkcheck.yml
@@ -9,6 +9,10 @@ on:
       - 'book/**'
   merge_group:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   linkcheck:
     name: Check broken links
diff --git a/.github/workflows/local-testnet.yml b/.github/workflows/local-testnet.yml
index ea4c1e24887..1269aee6270 100644
--- a/.github/workflows/local-testnet.yml
+++ b/.github/workflows/local-testnet.yml
@@ -8,6 +8,10 @@ on:
   pull_request:
   merge_group:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   run-local-testnet:
     strategy:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 30e4211b88c..e38b03daf70 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -5,6 +5,10 @@ on:
         tags:
             - v*
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 env:
     DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
     DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
diff --git a/.github/workflows/test-suite.yml b/.github/workflows/test-suite.yml
index ab31b3a92bc..91a0b734537 100644
--- a/.github/workflows/test-suite.yml
+++ b/.github/workflows/test-suite.yml
@@ -9,6 +9,11 @@ on:
       - 'pr/*'
   pull_request:
   merge_group:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 env:
   # Deny warnings in CI
   # Disable debug info (see https://github.com/sigp/lighthouse/issues/4005)