chore(ci): Require ready-to-merge label to run all checks

Author: antonis

.github/workflows/e2e-v2.yml

@@ -7,6 +7,7 @@ on:
       - v5
       - release/**
   pull_request:
+    types: [opened, synchronize, reopened, labeled]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -24,9 +25,15 @@ jobs:
   auth_token_check:
     uses: ./.github/workflows/skip-ci-noauth.yml
     secrets: inherit
+  ready-to-merge-gate:
+    name: Ready-to-merge gate
+    uses: ./.github/workflows/ready-to-merge-workflow.yml
+    with:
+      is-pr: ${{ github.event_name == 'pull_request' }}
+      labels: ${{ toJson(github.event.pull_request.labels) }}
   metrics:
     runs-on: ${{ matrix.runs-on }}
-    needs: [diff_check, auth_token_check]
+    needs: [ready-to-merge-gate,diff_check, auth_token_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' && needs.auth_token_check.outputs.skip_ci != 'true' && !startsWith(github.ref, 'refs/heads/release/') }}
     env:
       SENTRY_DISABLE_AUTO_UPLOAD: 'true'
@@ -158,7 +165,7 @@ jobs:
   react-native-build:
     name: Build RN ${{ matrix.rn-version }} ${{ matrix.rn-architecture }} ${{ matrix.engine }} ${{ matrix.platform }} ${{ matrix.build-type }} ${{ matrix.ios-use-frameworks }}
     runs-on: ${{ matrix.runs-on }}
-    needs: [diff_check, auth_token_check]
+    needs: [ready-to-merge-gate,diff_check, auth_token_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' && needs.auth_token_check.outputs.skip_ci != 'true' && !startsWith(github.ref, 'refs/heads/release/') }}
     env:
       RN_VERSION: ${{ matrix.rn-version }}
@@ -294,7 +301,7 @@ jobs:
     name:
       Test RN ${{ matrix.rn-version }} ${{ matrix.rn-architecture }} ${{ matrix.engine }} ${{ matrix.platform }} ${{
       matrix.build-type }} ${{ matrix.ios-use-frameworks }}
-    needs: [react-native-build, diff_check]
+    needs: [ready-to-merge-gate, react-native-build, diff_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
 
     runs-on: ${{ matrix.runs-on }}

.github/workflows/ready-to-merge-workflow.yml

@@ -0,0 +1,41 @@
+name: Ready to Merge Workflow
+on:
+  workflow_call:
+    inputs:
+      labels:
+        description: The GitHub event's labels
+        required: true
+        type: string
+      is-pr:
+        description: Whether the workflow is running on a PR
+        required: true
+        type: boolean
+
+jobs:
+  ready-to-merge-gate:
+    name: 'Missing "ready-to-merge" label'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for exact 'ready-to-merge' label
+        if: ${{ inputs.is-pr }}
+        id: check-label
+        run: |
+          # Use jq to check for exact label match (avoids substring matching issues with contains())
+          if echo '${{ inputs.labels }}' | jq -e '.[] | select(.name == "ready-to-merge")' > /dev/null; then
+            echo "label_found=true" >> $GITHUB_OUTPUT
+          else
+            echo "label_found=false" >> $GITHUB_OUTPUT
+          fi
+      # Since Github also accepts `skipped` results for Required Workflows, we need
+      # to fail the job to ensure that the downstream jobs don't just skip.
+      - name: Fail until the 'ready-to-merge' label is present
+        if: ${{ inputs.is-pr && steps.check-label.outputs.label_found == 'false' }}
+        run: |
+          echo "Add the 'ready-to-merge' label to run CI."
+          exit 1
+      - name: Gate passed
+        if: ${{ inputs.is-pr && steps.check-label.outputs.label_found == 'true' }}
+        run: echo "Label present. Proceeding with CI."
+      - name: Gate passed
+        if: ${{ !inputs.is-pr }}
+        run: echo "Not a PR. Proceeding with CI."

.github/workflows/sample-application-expo.yml

@@ -6,6 +6,7 @@ on:
       - main
       - v5
   pull_request:
+    types: [opened, synchronize, reopened, labeled]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -18,11 +19,16 @@ env:
 jobs:
   diff_check:
     uses: ./.github/workflows/skip-ci.yml
-
+  ready-to-merge-gate:
+    name: Ready-to-merge gate
+    uses: ./.github/workflows/ready-to-merge-workflow.yml
+    with:
+      is-pr: ${{ github.event_name == 'pull_request' }}
+      labels: ${{ toJson(github.event.pull_request.labels) }}
   build:
     name: Build ${{ matrix.platform }} ${{ matrix.build-type }} ${{ matrix.ios-use-frameworks}}
     runs-on: ${{ matrix.runs-on }}
-    needs: [diff_check]
+    needs: [ready-to-merge-gate, diff_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     env:
       SENTRY_DISABLE_AUTO_UPLOAD: 'true'

.github/workflows/sample-application.yml

@@ -6,6 +6,7 @@ on:
       - main
       - v5
   pull_request:
+    types: [opened, synchronize, reopened, labeled]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -25,11 +26,16 @@ env:
 jobs:
   diff_check:
     uses: ./.github/workflows/skip-ci.yml
-
+  ready-to-merge-gate:
+    name: Ready-to-merge gate
+    uses: ./.github/workflows/ready-to-merge-workflow.yml
+    with:
+      is-pr: ${{ github.event_name == 'pull_request' }}
+      labels: ${{ toJson(github.event.pull_request.labels) }}
   build:
     name: Build ${{ matrix.rn-architecture }} ${{ matrix.platform }} ${{ matrix.build-type }} ${{ matrix.ios-use-frameworks}}
     runs-on: ${{ matrix.runs-on }}
-    needs: [diff_check]
+    needs: [ready-to-merge-gate, diff_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     env:
       SENTRY_DISABLE_AUTO_UPLOAD: 'true'
@@ -215,7 +221,7 @@ jobs:
   test:
     name: Test ${{ matrix.platform }} ${{ matrix.build-type }} REV2
     runs-on: ${{ matrix.runs-on }}
-    needs: [diff_check, build]
+    needs: [ready-to-merge-gate, diff_check, build]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     strategy:
       # we want that the matrix keeps running, default is to cancel them if it fails.