ci: don't run CI on draft PRs (#7518)

PR adds a resuable workflow that prevents CI to run on draft PRs. To run CI on draft a new label is introduced: `A5-run-CI`. To run the CI the label should be added and en empty commit should be pushed. close paritytech/ci_cd#1099 close #7168
paritytech · Feb 18, 2025 · cc8f6e6 · cc8f6e6
1 parent c4b4145
commit cc8f6e6
Show file tree

Hide file tree

Showing 25 changed files with 102 additions and 8 deletions.
diff --git a/.github/workflows/benchmarks-subsystem.yml b/.github/workflows/benchmarks-subsystem.yml
@@ -16,9 +16,11 @@ permissions:
   contents: read
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
-
   build:
     timeout-minutes: 80
     needs: [preflight]

diff --git a/.github/workflows/build-misc.yml b/.github/workflows/build-misc.yml
@@ -16,7 +16,10 @@ permissions:
   contents: read
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   build-runtimes-polkavm:

diff --git a/.github/workflows/build-publish-eth-rpc.yml b/.github/workflows/build-publish-eth-rpc.yml
@@ -5,7 +5,7 @@ on:
     branches:
       - master
   pull_request:
-    types: [opened, synchronize, reopened, ready_for_review, labeled]
+    types: [opened, synchronize, reopened, ready_for_review]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -15,10 +15,13 @@ env:
   ETH_RPC_IMAGE_NAME: "docker.io/paritypr/eth-rpc"
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   set-variables:
     # This workaround sets the container image for each job using 'set-variables' job output.
     # env variables don't work for PR from forks, so we need to use outputs.
     runs-on: ubuntu-latest
+    needs: isdraft
     outputs:
       VERSION: ${{ steps.version.outputs.VERSION }}
     steps:
@@ -77,4 +80,3 @@ jobs:
           push: true
           tags: |
             ${{ env.ETH_RPC_IMAGE_NAME }}:${{ env.VERSION }}
-
diff --git a/.github/workflows/build-publish-images.yml b/.github/workflows/build-publish-images.yml
@@ -6,7 +6,7 @@ on:
     branches:
       - master
   pull_request:
-    types: [opened, synchronize, reopened, ready_for_review, labeled]
+    types: [opened, synchronize, reopened, ready_for_review]
   merge_group:
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -18,7 +18,10 @@ jobs:
   #
   #
   #
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   ### Build ########################

diff --git a/.github/workflows/check-cargo-check-runtimes.yml b/.github/workflows/check-cargo-check-runtimes.yml
@@ -13,7 +13,10 @@ on:
 # Jobs in this workflow depend on each other, only for limiting peak amount of spawned workers
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   check-runtime-assets:

diff --git a/.github/workflows/check-frame-omni-bencher.yml b/.github/workflows/check-frame-omni-bencher.yml
@@ -5,7 +5,7 @@ on:
     branches:
       - master
   pull_request:
-    types: [opened, synchronize, reopened, ready_for_review, labeled]
+    types: [opened, synchronize, reopened, ready_for_review]
   merge_group:
 
 concurrency:
@@ -16,7 +16,10 @@ env:
   ARTIFACTS_NAME: frame-omni-bencher-artifacts
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   quick-benchmarks-omni:

diff --git a/.github/workflows/check-getting-started.yml b/.github/workflows/check-getting-started.yml
@@ -26,16 +26,19 @@ on:
     paths:
       - ".github/workflows/check-getting-started.yml"
       - "scripts/getting-started.sh"
+    types: [opened, synchronize, reopened, ready_for_review]
   schedule:
     - cron: "0 5 * * *"
-  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   check-getting-started:
+    needs: isdraft
     strategy:
       fail-fast: true
       matrix:
@@ -179,6 +182,7 @@ jobs:
         timeout-minutes: 5
 
   check-getting-started-macos:
+    needs: isdraft
     strategy:
       fail-fast: true
       matrix:

diff --git a/.github/workflows/check-licenses.yml b/.github/workflows/check-licenses.yml
@@ -2,6 +2,7 @@ name: Check licenses
 
 on:
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
   merge_group:
 
 concurrency:
@@ -12,8 +13,11 @@ permissions:
   packages: read
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   check-licenses:
     runs-on: ubuntu-latest
+    needs: isdraft
     timeout-minutes: 10
     env:
       LICENSES: "'Apache-2.0' 'GPL-3.0-only' 'GPL-3.0-or-later WITH Classpath-exception-2.0' 'MIT-0' 'Unlicense'"

diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml
@@ -18,8 +18,11 @@ permissions:
   packages: read
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   link-checker:
     runs-on: ubuntu-latest
+    needs: isdraft
     timeout-minutes: 10
     steps:
       - name: Restore lychee cache

diff --git a/.github/workflows/check-runtime-migration.yml b/.github/workflows/check-runtime-migration.yml
@@ -19,7 +19,10 @@ concurrency:
 permissions: {}
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   # More info can be found here: https://github.com/paritytech/polkadot/pull/5865

diff --git a/.github/workflows/check-semver.yml b/.github/workflows/check-semver.yml
@@ -14,7 +14,10 @@ env:
   TOOLCHAIN: nightly-2024-11-19
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
   check-semver:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/checks-quick.yml b/.github/workflows/checks-quick.yml
@@ -15,7 +15,10 @@ concurrency:
 permissions: {}
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   fmt:
@@ -37,6 +40,7 @@ jobs:
           app-key: ${{ secrets.WORKFLOW_STOPPER_RUNNER_APP_KEY }}
   check-dependency-rules:
     runs-on: ubuntu-latest
+    needs: isdraft
     timeout-minutes: 20
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7
@@ -84,6 +88,7 @@ jobs:
           echo "Please run `taplo format --config .config/taplo.toml` to fix any toml formatting issues"
   check-workspace:
     runs-on: ubuntu-latest
+    needs: isdraft
     timeout-minutes: 20
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.0 (22. Sep 2023)
@@ -102,6 +107,7 @@ jobs:
         run: python3 .github/scripts/deny-git-deps.py .
   check-markdown:
     runs-on: ubuntu-latest
+    needs: isdraft
     timeout-minutes: 20
     steps:
       - name: Checkout sources
@@ -154,6 +160,7 @@ jobs:
           fi
   check-fail-ci:
     runs-on: ubuntu-latest
+    needs: isdraft
     container:
       # there's no "rg" in ci-unified, and tools is a smaller image anyway
       image: "paritytech/tools:latest"
@@ -179,6 +186,7 @@ jobs:
           GIT_DEPTH: 1
   check-readme:
     runs-on: ubuntu-latest
+    needs: isdraft
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -15,7 +15,10 @@ concurrency:
 permissions: {}
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   cargo-clippy:

diff --git a/.github/workflows/cmd-tests.yml b/.github/workflows/cmd-tests.yml
@@ -2,6 +2,7 @@ name: Command Bot Tests
 
 on:
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
 
 permissions:
   contents: read
@@ -11,8 +12,11 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   test-cmd-bot:
     runs-on: ubuntu-latest
+    needs: [isdraft]
     steps:
       - uses: actions/checkout@v4
       - run: python3 .github/scripts/cmd/test_cmd.py
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -5,15 +5,18 @@ on:
     branches:
       - master
   pull_request:
-    types: [opened, synchronize, reopened, ready_for_review, labeled]
+    types: [opened, synchronize, reopened, ready_for_review]
   merge_group:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   test-doc:
@@ -77,6 +80,7 @@ jobs:
 
   build-implementers-guide:
     runs-on: ubuntu-latest
+    needs: isdraft
     container:
       image: paritytech/mdbook-utils:e14aae4a-20221123
       options: --user root

diff --git a/.github/workflows/gitspiegel-trigger.yml b/.github/workflows/gitspiegel-trigger.yml
@@ -28,8 +28,11 @@ on:
 permissions: {}
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   sync:
     runs-on: ubuntu-latest
+    needs: isdraft
     steps:
       - name: Do nothing
         run: echo "let's go"
diff --git a/.github/workflows/publish-check-compile.yml b/.github/workflows/publish-check-compile.yml
@@ -13,7 +13,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   check-publish-compile:

diff --git a/.github/workflows/publish-check-crates.yml b/.github/workflows/publish-check-crates.yml
@@ -13,8 +13,11 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   check-publish:
     runs-on: ubuntu-latest
+    needs: isdraft
     steps:
       - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7
 

diff --git a/.github/workflows/reusable-isdraft.yml b/.github/workflows/reusable-isdraft.yml
@@ -0,0 +1,16 @@
+# The workflow is not part of reusable-preflight.yml to allow testing CI in draft.
+
+name: Preflight isdraft
+
+on:
+  workflow_call:
+    # Map the workflow outputs to job outputs
+
+jobs:
+  isdraft:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.draft == false || contains(github.event.pull_request.labels.*.name, 'A5-run-CI')
+    steps:
+      - name: echo test
+        shell: bash
+        run: echo "PR is not draft, starting CI"
diff --git a/.github/workflows/tests-evm.yml b/.github/workflows/tests-evm.yml
@@ -12,7 +12,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   evm-test-suite:

diff --git a/.github/workflows/tests-linux-stable.yml b/.github/workflows/tests-linux-stable.yml
@@ -13,7 +13,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   test-linux-stable-int:

diff --git a/.github/workflows/tests-misc.yml b/.github/workflows/tests-misc.yml
@@ -14,7 +14,10 @@ concurrency:
 # Jobs in this workflow depend on each other, only for limiting peak amount of spawned workers
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   # more information about this job can be found here:

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -12,7 +12,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  isdraft:
+    uses: ./.github/workflows/reusable-isdraft.yml
   preflight:
+    needs: isdraft
     uses: ./.github/workflows/reusable-preflight.yml
 
   # This job runs all benchmarks defined in the `/bin/node/runtime` once to check that there are no errors.