[WIP][ci] Add worfklow stopper (paritytech#4551)

PR to implements workflow stopper - a custom solution to stop all workflows if one of a required jobs failed. Previously we had the same solution in GitLab and it saved a lot of compute. Because GitHub doesn't have one united pipeline and instead it has multiple workflows something like this has to be implemented. cc https://github.com/paritytech/ci_cd/issues/939
paraspell-research · Jan 4, 2025 · 9f4797f · 9f4797f
1 parent 3a07674
commit 9f4797f
Show file tree

Hide file tree

Showing 8 changed files with 140 additions and 3 deletions.
diff --git a/.github/actions/workflow-stopper/action.yml b/.github/actions/workflow-stopper/action.yml
@@ -0,0 +1,28 @@
+name: "stop all workflows"
+description: "Action stops all workflows in a PR to save compute resources."
+inputs:
+  app-id:
+    description: "App id"
+    required: true
+  app-key:
+    description: "App token"
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - name: Worfklow stopper - Generate token
+      uses: actions/create-github-app-token@v1
+      id: app-token
+      with:
+        app-id: ${{ inputs.app-id }}
+        private-key: ${{ inputs.app-key }}
+        owner: "paritytech"
+        repositories: "workflow-stopper"
+    - name: Workflow stopper - Stop all workflows
+      uses: octokit/[email protected]
+      with:
+        route: POST /repos/paritytech/workflow-stopper/actions/workflows/stopper.yml/dispatches
+        ref: main
+        inputs: '${{ format(''{{ "github_sha": "{0}", "github_repository": "{1}", "github_ref_name": "{2}", "github_workflow_id": "{3}", "github_job_name": "{4}" }}'', github.event.pull_request.head.sha, github.repository, github.ref_name, github.run_id, github.job) }}'
+      env:
+        GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
diff --git a/.github/workflows/build-misc.yml b/.github/workflows/build-misc.yml
@@ -16,7 +16,6 @@ permissions:
   contents: read
 
 jobs:
-
   preflight:
     uses: ./.github/workflows/reusable-preflight.yml
 
@@ -38,11 +37,18 @@ jobs:
       - name: Build
         env:
           SUBSTRATE_RUNTIME_TARGET: riscv
+        id: required
         run: |
           forklift cargo check -p minimal-template-runtime
           forklift cargo check -p westend-runtime
           forklift cargo check -p rococo-runtime
           forklift cargo check -p polkadot-test-runtime
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   build-subkey:
     timeout-minutes: 20
@@ -62,9 +68,16 @@ jobs:
       - name: Build
         env:
           SKIP_WASM_BUILD: 1
+        id: required
         run: |
           cd ./substrate/bin/utils/subkey
           forklift cargo build --locked --release
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   confirm-required-build-misc-jobs-passed:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/check-frame-omni-bencher.yml b/.github/workflows/check-frame-omni-bencher.yml
@@ -36,9 +36,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: script
+        id: required
         run: |
           forklift cargo build --locked --quiet --release -p asset-hub-westend-runtime --features runtime-benchmarks
           forklift cargo run --locked --release -p frame-omni-bencher --quiet -- v1 benchmark pallet --runtime target/release/wbuild/asset-hub-westend-runtime/asset_hub_westend_runtime.compact.compressed.wasm --all --steps 2 --repeat 1 --quiet
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   runtime-matrix:
     runs-on: ubuntu-latest
@@ -80,6 +87,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: script
+        id: required
         run: |
           RUNTIME_BLOB_NAME=$(echo $PACKAGE_NAME | sed 's/-/_/g').compact.compressed.wasm
           RUNTIME_BLOB_PATH=./target/release/wbuild/$PACKAGE_NAME/$RUNTIME_BLOB_NAME
@@ -90,6 +98,13 @@ jobs:
           cmd="./target/release/frame-omni-bencher v1 benchmark pallet --runtime $RUNTIME_BLOB_PATH --all --steps 2 --repeat 1 $FLAGS"
           echo "Running command: $cmd"
           eval "$cmd"
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
+
   confirm-frame-omni-benchers-passed:
     runs-on: ubuntu-latest
     name: All benchmarks passed

diff --git a/.github/workflows/check-runtime-migration.yml b/.github/workflows/check-runtime-migration.yml
@@ -101,20 +101,29 @@ jobs:
           ./try-runtime create-snapshot --uri ${{ matrix.uri }} snapshot.raw
 
       - name: Build Runtime
+        id: required1
         run: |
           echo "---------- Building ${{ matrix.package }} runtime ----------"
-          time forklift cargo build --release --locked -p ${{ matrix.package }} --features try-runtime -q
+          forklift cargo build --release --locked -p ${{ matrix.package }} --features try-runtime -q
 
       - name: Run Check
+        id: required2
         run: |
           echo "Running ${{ matrix.network }} runtime migration check"
           export RUST_LOG=remote-ext=debug,runtime=debug
 
           echo "---------- Executing on-runtime-upgrade for ${{ matrix.network }} ----------"
-          time ./try-runtime ${{ matrix.command_extra_args }} \
+          ./try-runtime ${{ matrix.command_extra_args }} \
               --runtime ./target/release/wbuild/${{ matrix.package }}/${{ matrix.wasm }} \
               on-runtime-upgrade --disable-spec-version-check --checks=all ${{ matrix.subcommand_extra_args }} snap -p snapshot.raw
           sleep 5
+      - name: Stop all workflows if failed
+        if: ${{ failure() && (steps.required1.conclusion == 'failure' || steps.required2.conclusion == 'failure') }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
+
   # name of this job must be unique across all workflows
   # otherwise GitHub will mark all these jobs as required
   confirm-required-checks-passed:

diff --git a/.github/workflows/checks-quick.yml b/.github/workflows/checks-quick.yml
@@ -27,7 +27,14 @@ jobs:
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7
       - name: Cargo fmt
+        id: required
         run: cargo +nightly fmt --all -- --check
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
   check-dependency-rules:
     runs-on: ubuntu-latest
     timeout-minutes: 20

diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -31,9 +31,17 @@ jobs:
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7
       - name: script
+        id: required
         run: |
           cargo clippy --all-targets --locked --workspace --quiet
           cargo clippy --all-targets --all-features --locked --workspace --quiet
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
+
   check-try-runtime:
     runs-on: ${{ needs.preflight.outputs.RUNNER }}
     needs: [preflight]
@@ -44,6 +52,7 @@ jobs:
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7
       - name: script
+        id: required
         run: |
           forklift cargo check --locked --all --features try-runtime --quiet
           # this is taken from cumulus
@@ -52,6 +61,13 @@ jobs:
           # add after https://github.com/paritytech/substrate/pull/14502 is merged
           # experimental code may rely on try-runtime and vice-versa
           forklift cargo check --locked --all --features try-runtime,experimental --quiet
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
+
   # check-core-crypto-features works fast without forklift
   check-core-crypto-features:
     runs-on: ${{ needs.preflight.outputs.RUNNER }}
@@ -63,6 +79,7 @@ jobs:
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7
       - name: script
+        id: required
         run: |
           cd substrate/primitives/core
           ./check-features-variants.sh
@@ -73,6 +90,12 @@ jobs:
           cd substrate/primitives/keyring
           ./check-features-variants.sh
           cd -
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
   # name of this job must be unique across all workflows
   # otherwise GitHub will mark all these jobs as required
   confirm-required-checks-passed:

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -25,8 +25,15 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - run: forklift cargo test --doc --workspace
+        id: required
         env:
           RUSTFLAGS: "-Cdebug-assertions=y -Dwarnings"
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   build-rustdoc:
     runs-on: ${{ needs.preflight.outputs.RUNNER }}
@@ -38,6 +45,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - run: forklift cargo doc --all-features --workspace --no-deps
+        id: required
         env:
           SKIP_WASM_BUILD: 1
           RUSTDOCFLAGS: "-Dwarnings --default-theme=ayu --html-in-header ./docs/sdk/assets/header.html --extend-css ./docs/sdk/assets/theme.css --html-after-content ./docs/sdk/assets/after-content.html"
@@ -60,6 +68,12 @@ jobs:
           path: ./crate-docs/
           retention-days: 1
           if-no-files-found: error
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   build-implementers-guide:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/tests-linux-stable.yml b/.github/workflows/tests-linux-stable.yml
@@ -34,7 +34,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: script
+        id: required
         run: WASM_BUILD_NO_COLOR=1 forklift cargo test -p staging-node-cli --release --locked -- --ignored
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   # https://github.com/paritytech/ci_cd/issues/864
   test-linux-stable-runtime-benchmarks:
@@ -53,7 +60,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: script
+        id: required
         run: forklift cargo nextest run --workspace --features runtime-benchmarks benchmark --locked --cargo-profile testnet --cargo-quiet
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   test-linux-stable:
     needs: [preflight]
@@ -82,6 +96,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: script
+        id: required
         run: |
           # Fixes "detected dubious ownership" error in the ci
           git config --global --add safe.directory '*'
@@ -97,6 +112,12 @@ jobs:
       - name: runtime-api tests
         if: ${{ matrix.partition == '1/3' }}
         run: forklift cargo nextest run -p sp-api-test --features enable-staging-api --cargo-quiet
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   # some tests do not run with `try-runtime` feature enabled
   # https://github.com/paritytech/polkadot-sdk/pull/4251#discussion_r1624282143
@@ -123,6 +144,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: script
+        id: required
         run: |
           forklift cargo nextest run --workspace \
                    --locked \
@@ -132,6 +154,12 @@ jobs:
                    --features experimental,ci-only-tests \
                    --filter-expr " !test(/all_security_features_work/) - test(/nonexistent_cache_dir/)" \
                    --partition count:${{ matrix.partition }} \
+      - name: Stop all workflows if failed
+        if: ${{ failure() && steps.required.conclusion == 'failure' }}
+        uses: ./.github/actions/workflow-stopper
+        with:
+          app-id: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_ID }}
+          app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
 
   confirm-required-jobs-passed:
     runs-on: ubuntu-latest