Skip some CIs if only Docs/ has changed

Author: WeiqunZhang

.github/workflows/apps.yml

@@ -7,9 +7,14 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   castro:
     name: Castro
     runs-on: ubuntu-latest
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Get Latest Release Tag
@@ -62,6 +67,8 @@ jobs:
   warpx:
     name: WarpX
     runs-on: ubuntu-latest
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Download WarpX
@@ -105,7 +112,8 @@ jobs:
   pyamrex:
     name: pyamrex
     runs-on: ubuntu-latest
-    steps:
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     - uses: actions/checkout@v4
     - name: Checkout pyamrex
       uses: actions/checkout@v4

.github/workflows/bittree.yml

@@ -7,9 +7,14 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   bittree-2d:
     name: Bittree 2D
     runs-on: ubuntu-latest
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -62,6 +67,8 @@ jobs:
   bittree-3d:
     name: Bittree 3D
     runs-on: ubuntu-latest
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies

.github/workflows/catalyst.yml

@@ -7,10 +7,14 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   catalyst:
     name: Catalyst
     runs-on: ubuntu-22.04
-    if: github.event.pull_request.draft == false
+    needs: check_changes
+    if: github.event.pull_request.draft == false && needs.check_changes.outputs.has_non_docs_changes == 'true'
     env:
       CXX: g++
       CC: gcc

.github/workflows/check_changes.yml

@@ -0,0 +1,29 @@
+name: Check Changes
+
+on:
+  workflow_call:
+    outputs:
+      has_docs_changes:
+        value: ${{ jobs.check.outputs.has_docs_changes }}
+      has_non_docs_changes:
+        value: ${{ jobs.check.outputs.has_non_docs_changes }}
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      has_non_docs_changes: ${{ steps.set-output.outputs.has_non_docs_changes }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: changes
+        with:
+          filters: |
+            docs:
+              - 'Docs/**'
+            others:
+              - '!Docs/**'
+      - id: set-output
+        run: |
+          echo "has_docs_changes=${{ steps.changes.outputs.docs }}" >> $GITHUB_OUTPUT
+          echo "has_non_docs_changes=${{ steps.changes.outputs.others }}" >> $GITHUB_OUTPUT

.github/workflows/clang.yml

@@ -1,5 +1,3 @@
-# -Wno-c++17-extensions: Clang complains about nodiscard if the standard is not set to c++17.
-
 name: LinuxClang
 
 on: [push, pull_request]
@@ -9,11 +7,16 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   # Build and install libamrex as AMReX CMake project
   # Note: this is an intentional "minimal" build that does not enable (many) options
   library_clang:
     name: [email protected] C++17 SP NOMPI Debug [lib]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -75,6 +78,8 @@ jobs:
   tests_clang:
     name: [email protected] C++17 SP Particles DP Mesh Debug [tests]
     runs-on: ubuntu-22.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -131,6 +136,8 @@ jobs:
   tests_cxx20:
     name: Clang C++20 [tests]
     runs-on: ubuntu-22.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -180,6 +187,8 @@ jobs:
   configure-2d:
     name: Clang NOMPI Release [configure 2D]
     runs-on: ubuntu-22.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies

.github/workflows/codeql.yml

@@ -13,8 +13,12 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   analyze:
-    if: ${{ github.repository == 'AMReX-Codes/amrex' || github.event_name != 'schedule' }}
+    needs: check_changes
+    if: ${{ github.repository == 'AMReX-Codes/amrex' || github.event_name != 'schedule' }} && needs.check_changes.outputs.has_non_docs_changes == 'true'
     name: Analyze
     runs-on: ubuntu-latest
     permissions:

.github/workflows/cuda.yml

@@ -7,10 +7,15 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   # Build libamrex and all tests with CUDA 11.2
   tests-cuda11:
     name: [email protected] [email protected] C++17 Release [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -62,6 +67,8 @@ jobs:
   tests-cuda11-clang:
     name: Clang@15 [email protected] C++17 Release [tests]
     runs-on: ubuntu-22.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     env:
       CC: clang-15
       CXX: clang++-15
@@ -115,6 +122,8 @@ jobs:
   tests-nvhpc-nvcc:
     name: NVHPC NVCC/NVC++ C++17 Release [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -178,6 +187,8 @@ jobs:
   configure-3d-cuda:
     name: [email protected] [email protected] [configure 3D]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies

.github/workflows/gcc.yml

@@ -10,11 +10,16 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   # Build and install libamrex as AMReX CMake project
   # Note: this is an intentional "minimal" build that does not enable (many) options
   library:
     name: [email protected] C++17 Release [lib]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -72,6 +77,8 @@ jobs:
   tests_build_3D:
     name: GNU@13 C++17 3D Debug Fortran [tests]
     runs-on: ubuntu-24.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -121,6 +128,8 @@ jobs:
   tests_build_2D:
     name: [email protected] C++17 2D Debug Fortran [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -170,6 +179,8 @@ jobs:
   tests_build_1D:
     name: [email protected] C++17 1D Debug Fortran [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -221,6 +232,8 @@ jobs:
   tests_cxx20:
     name: [email protected] C++20 OMP [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -281,6 +294,8 @@ jobs:
   tests-nonmpi:
     name: [email protected] C++17 NOMPI [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -340,6 +355,8 @@ jobs:
   tests-nofortran:
     name: GNU@12 C++17 w/o Fortran [tests]
     runs-on: ubuntu-22.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -401,6 +418,8 @@ jobs:
   configure-1d:
     name: [email protected] Release [configure 1D]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -441,6 +460,8 @@ jobs:
   configure-3d:
     name: [email protected] Release [configure 3D]
     runs-on: ubuntu-22.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -481,6 +502,8 @@ jobs:
   configure-3d-single-tprof:
     name: [email protected] Release [configure 3D]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -522,6 +545,8 @@ jobs:
   configure-3d-omp-debug:
     name: [email protected] OMP Debug [configure 3D]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -562,6 +587,8 @@ jobs:
   plotfile-tools:
     name: GNU Plotfile Tools [tools]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -601,6 +628,8 @@ jobs:
   tests_run:
     name: GNU@13 C++17 [tests]
     runs-on: ubuntu-24.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -651,6 +680,8 @@ jobs:
   test_hdf5:
     name: [email protected] HDF5 I/O Test [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     env:
       CXX: h5pcc
       CC: h5cc

.github/workflows/hip.yml

@@ -7,9 +7,14 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  check_changes:
+    uses: ./.github/workflows/check_changes.yml
+
   tests-hip:
     name: HIP ROCm Flang C++17 [tests]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -69,6 +74,8 @@ jobs:
   tests-hip-wrapper:
     name: HIP ROCm [email protected] C++17 [tests-hipcc]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -127,6 +134,8 @@ jobs:
   configure-2d-single-hip:
     name: HIP EB [configure 2D]
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies
@@ -160,6 +169,8 @@ jobs:
   hip-3d-eb-gmake:
     name: HIP EB 3D GMake
     runs-on: ubuntu-20.04
+    needs: check_changes
+    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
     steps:
     - uses: actions/checkout@v4
     - name: Dependencies