feat(ci): Skip CI for commits without code changes (#3545)

Author: lucas-zimerman

.github/workflows/buildandtest.yml

@@ -8,9 +8,14 @@ on:
   pull_request:
 
 jobs:
+  diff_check:
+    uses: ./.github/workflows/skip-ci.yml
+
   job_test:
     name: Test
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -30,6 +35,8 @@ jobs:
   job_lint:
     name: Lint
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/cache@v3
@@ -46,6 +53,8 @@ jobs:
   job_lint_sample_new_arch:
     name: Lint Sample
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/cache@v3
@@ -64,6 +73,8 @@ jobs:
   job_check_integrity:
     name: Check package integrity
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/cache@v3
@@ -82,6 +93,8 @@ jobs:
   job_build:
     name: Build
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -124,7 +137,8 @@ jobs:
   job_type_check:
     name: Type Check Typescript 3.8
     runs-on: ubuntu-latest
-    needs: [job_build]
+    needs: [job_build, diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -163,7 +177,8 @@ jobs:
   job_circular_dep_check:
     name: Circular Dependency Check
     runs-on: ubuntu-latest
-    needs: [job_build]
+    needs: [job_build, diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -194,7 +209,8 @@ jobs:
   job_bundle:
     name: Bundle
     runs-on: ubuntu-latest
-    needs: [job_test, job_build]
+    needs: [job_test, job_build, diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     strategy:
       # we want that the matrix keeps running, default is to cancel them if it fails.
       fail-fast: false

.github/workflows/codegen.yml

@@ -8,8 +8,13 @@ on:
   pull_request:
 
 jobs:
+  diff_check:
+    uses: ./.github/workflows/skip-ci.yml
+
   codegen:
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     strategy:
       matrix:
         platform: ["android", "ios"]

.github/workflows/codeql-analysis.yml

@@ -21,9 +21,14 @@ on:
     - cron: '27 16 * * 5'
 
 jobs:
+  diff_check:
+    uses: ./.github/workflows/skip-ci.yml
+
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
 
     strategy:
       fail-fast: false

.github/workflows/e2e.yml

@@ -13,8 +13,13 @@ env:
   SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
 
 jobs:
+  diff_check:
+    uses: ./.github/workflows/skip-ci.yml
+
   cancel-previous-workflow:
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - name: Cancel Previous Runs
         uses: styfle/cancel-workflow-action@01ce38bf961b4e243a6342cbade0dbc8ba3f0432 # pin@0.12.0
@@ -23,6 +28,8 @@ jobs:
 
   metrics:
     runs-on: ${{ matrix.runs-on }}
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     strategy:
       # we want that the matrix keeps running, default is to cancel them if it fails.
       fail-fast: false
@@ -146,6 +153,8 @@ 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]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     env:
       RN_SENTRY_POD_NAME: RNSentry
       RN_DIFF_REPOSITORY: https://github.com/react-native-community/rn-diff-purge.git
@@ -410,8 +419,12 @@ jobs:
           path: test/react-native/versions/${{ matrix.rn-version }}/RnDiffApp/ios/*.log
 
   react-native-test:
-    name: Test RN ${{ matrix.rn-version }} ${{ matrix.rn-architecture }} ${{ matrix.engine }} ${{ matrix.platform }} ${{ matrix.build-type }} ${{ matrix.ios-use-frameworks }}
-    needs: react-native-build
+    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]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
+
     runs-on: ${{ matrix.runs-on }}
     strategy:
       fail-fast: false # keeps matrix running if one fails

.github/workflows/native-tests.yml

@@ -6,8 +6,13 @@ on:
   pull_request:
 
 jobs:
+  diff_check:
+    uses: ./.github/workflows/skip-ci.yml
+
   cancel-previous-workflow:
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - name: Cancel Previous Runs
         uses: styfle/cancel-workflow-action@01ce38bf961b4e243a6342cbade0dbc8ba3f0432 # pin@0.12.0
@@ -17,6 +22,8 @@ jobs:
   test-ios:
     name: ios
     runs-on: macos-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
 
@@ -51,6 +58,8 @@ jobs:
   test-android:
     name: android
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - uses: actions/checkout@v4
 

.github/workflows/sample-application.yml

@@ -14,8 +14,13 @@ env:
   RN_SENTRY_POD_NAME: RNSentry
 
 jobs:
+  diff_check:
+    uses: ./.github/workflows/skip-ci.yml
+
   cancel-previous-workflow:
     runs-on: ubuntu-latest
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     steps:
       - name: Cancel Previous Runs
         uses: styfle/cancel-workflow-action@01ce38bf961b4e243a6342cbade0dbc8ba3f0432 # pin@0.12.0
@@ -25,6 +30,8 @@ jobs:
   build:
     name: Build ${{ matrix.rn-architecture }} ${{ matrix.platform }} ${{ matrix.build-type }}
     runs-on: ${{ matrix.runs-on }}
+    needs: [diff_check]
+    if: ${{ needs.diff_check.outputs.skip_ci != 'true' }}
     strategy:
       # we want that the matrix keeps running, default is to cancel them if it fails.
       fail-fast: false

.github/workflows/skip-ci.yml

@@ -0,0 +1,36 @@
+name: Skip CI
+on:
+  workflow_call:
+    outputs:
+      skip_ci:
+        description: "Value yes if the current PR only contains changes to files not related to code, otherwise, not defined."
+        value: ${{ jobs.diff_check.outputs.skip_ci }}
+
+jobs:
+  diff_check:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    outputs:
+      skip_ci:
+        ${{ steps.check_diff.outputs.skip_ci }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check diff from Pull Request
+        id: check_diff
+        run: |
+          skipList=(".github/CODEOWNERS" ".prettierignore")
+          # Ignores changelog.md, readme.md,...
+          fileChangesArray=($(git diff --name-only  origin/${{ github.base_ref }}..origin/${{ github.head_ref }} | grep -v '\.md$'))
+          printf '%s\n' "${fileChangesArray[@]}"
+          for item in "${fileChangesArray[@]}"
+          do
+            if [[ ! " ${skipList[@]} " =~ " ${item} " ]]; then
+              #found an item that doesn't belong to the skip list.
+              exit 0
+            fi
+          done
+          echo "skip_ci=true" >> $GITHUB_OUTPUT
+          echo "no source code files commited, skipping CI."

.prettierignore

@@ -1,3 +1,3 @@
 /test/react-native/versions
-CHANGELOG.md
-
+.github/workflows/*.yml
+*.md