Add doc and update condition

Author: antonis

.github/workflows/e2e-v2.yml

@@ -20,20 +20,22 @@ env:
   IOS_VERSION: '18.1'
 
 jobs:
-  diff_check:
-    uses: ./.github/workflows/skip-ci.yml
-  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) }}
+
+  diff_check:
+    needs: [ready-to-merge-gate]
+    uses: ./.github/workflows/skip-ci.yml
+  auth_token_check:
+    uses: ./.github/workflows/skip-ci-noauth.yml
+    secrets: inherit
   metrics:
     runs-on: ${{ matrix.runs-on }}
-    needs: [ready-to-merge-gate,diff_check, auth_token_check]
+    needs: [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'
@@ -165,7 +167,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: [ready-to-merge-gate,diff_check, auth_token_check]
+    needs: [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 }}
@@ -301,7 +303,7 @@ jobs:
     name:
       Test RN ${{ matrix.rn-version }} ${{ matrix.rn-architecture }} ${{ matrix.engine }} ${{ matrix.platform }} ${{
       matrix.build-type }} ${{ matrix.ios-use-frameworks }}
-    needs: [ready-to-merge-gate, react-native-build, diff_check]
+    needs: [react-native-build, diff_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
 
     runs-on: ${{ matrix.runs-on }}

.github/workflows/native-tests.yml

@@ -7,13 +7,22 @@ on:
       - v5
       - release/**
   pull_request:
-
+    types: [opened, synchronize, reopened, labeled]
+    
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
 jobs:
+  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) }}
+
   diff_check:
+    needs: [ready-to-merge-gate]
     uses: ./.github/workflows/skip-ci.yml
 
   test-ios:

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

@@ -17,18 +17,21 @@ env:
   RN_SENTRY_POD_NAME: RNSentry
 
 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) }}
+
+  diff_check:
+    needs: [ready-to-merge-gate]
+    uses: ./.github/workflows/skip-ci.yml
+
   build:
     name: Build ${{ matrix.platform }} ${{ matrix.build-type }} ${{ matrix.ios-use-frameworks}}
     runs-on: ${{ matrix.runs-on }}
-    needs: [ready-to-merge-gate, diff_check]
+    needs: [diff_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     env:
       SENTRY_DISABLE_AUTO_UPLOAD: 'true'

.github/workflows/sample-application.yml

@@ -24,18 +24,21 @@ env:
   ANDROID_API_LEVEL: '30'
 
 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) }}
+
+  diff_check:
+    needs: [ready-to-merge-gate]
+    uses: ./.github/workflows/skip-ci.yml
+
   build:
     name: Build ${{ matrix.rn-architecture }} ${{ matrix.platform }} ${{ matrix.build-type }} ${{ matrix.ios-use-frameworks}}
     runs-on: ${{ matrix.runs-on }}
-    needs: [ready-to-merge-gate, diff_check]
+    needs: [diff_check]
     if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     env:
       SENTRY_DISABLE_AUTO_UPLOAD: 'true'
@@ -221,7 +224,7 @@ jobs:
   test:
     name: Test ${{ matrix.platform }} ${{ matrix.build-type }} REV2
     runs-on: ${{ matrix.runs-on }}
-    needs: [ready-to-merge-gate, diff_check, build]
+    needs: [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.

CI.md

@@ -0,0 +1,25 @@
+# CI inner working
+
+## `ready-to-merge` label
+
+CI checks are great, but macOS runners are limited on every provider, because of this, we need to be smarter on how we run jobs.
+To avoid running many jobs on every PR's commit, we have decided to only run a subset of tests regularily and run the full suite only when the PR has the label `ready-to-merge`.
+
+### How to use the gate
+
+Add this job at the start the workflow and then add `need: ready-to-merge-gate` to jobs that you want to be skipped.
+
+```
+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) }}
+```
+
+This job will:
+
+- Pass if the event is not a PR
+- Fail if the event is a PR and is missing the `ready-to-merge` label
+- Pass if the event is a PR and is has the `ready-to-merge` label