conditionally run jobs based on detected changes

Signed-off-by: Swapnanil Gupta <swpnlg@amazon.com>

Author: Swapnanil-Gupta

.github/workflows/ci-release.yaml

@@ -7,16 +7,18 @@ on:
       - '**.go'
       - 'go.mod'
       - 'go.sum'
-      - '.github/workflows/e2e-macos.yaml'
-      - '.github/workflows/e2e-windows.yaml'
-      - '.github/workflows/e2e-linux.yaml'
       - 'contrib/packaging/**'
       - 'deps/**'
       - 'finch.yaml.d/**'
       - 'winres'
       - 'Makefile*'
       - '.golangci.yaml'
       - '!contrib/hello-finch/**'
+      - '.github/workflows/e2e-macos.yaml'
+      - '.github/workflows/e2e-windows.yaml'
+      - '.github/workflows/e2e-linux.yaml'
+      - '.github/workflows/e2e-ubuntu.yaml'
+      - '.github/workflows/ci.yaml'
       - '.github/workflows/ci-release.yaml'
       - '.github/workflows/release-automation.yaml'
       - '.github/workflows/upload-installer-to-release.yaml'
@@ -27,10 +29,6 @@ on:
       - '.github/workflows/test-pkg.yaml'
       - '.github/workflows/build-and-test-msi.yaml'
       - '.github/workflows/build-and-test-deb.yaml'
-      - '.github/workflows/e2e-macos.yaml'
-      - '.github/workflows/e2e-windows.yaml'
-      - '.github/workflows/e2e-linux.yaml'
-      - '.github/workflows/e2e-ubuntu.yaml'
       - '.github/workflows/get-version-and-tag-for-ref.yaml'
       # - '.github/workflows/build-linux.yaml'
   pull_request:
@@ -44,15 +42,16 @@ on:
       - '.github/workflows/test-pkg.yaml'
       - '.github/workflows/build-and-test-msi.yaml'
       - '.github/workflows/build-and-test-deb.yaml'
-      - '.github/workflows/get-version-and-tag-for-ref.yaml'
       - 'installer-builder/**'
       - 'msi-builder/**'
+      - 'contrib/packaging/deb/**'
       # - '.github/workflows/build-linux.yaml'
   workflow_dispatch:
 
 permissions:
   id-token: write
   contents: write
+  pull-requests: read
 
 env:
   DEBUG: ${{ secrets.ACTIONS_STEP_DEBUG }}
@@ -62,6 +61,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  changes:
+    uses: ./.github/workflows/detect-changes.yaml
+    secrets: inherit
+
   run-ci-checks:
     uses: ./.github/workflows/ci.yaml
     secrets: inherit
@@ -85,7 +88,8 @@ jobs:
             echo "version=$version" >> ${GITHUB_OUTPUT}
 
   build-and-test-finch-pkg:
-    needs: get-intermediate-version
+    needs: [get-intermediate-version, changes]
+    if: ${{ needs.changes.outputs.mac-build == 'true' }}
     uses: ./.github/workflows/build-and-test-pkg.yaml
     permissions:
       id-token: write
@@ -96,7 +100,8 @@ jobs:
       version: ${{ needs.get-intermediate-version.outputs.version }}
 
   build-and-test-finch-msi:
-    needs: get-intermediate-version
+    needs: [get-intermediate-version, changes]
+    if: ${{ needs.changes.outputs.win-build == 'true' }}
     uses: ./.github/workflows/build-and-test-msi.yaml
     permissions:
       id-token: write
@@ -107,7 +112,8 @@ jobs:
       version: ${{ needs.get-intermediate-version.outputs.version }}
 
   build-and-test-finch-deb:
-    needs: get-intermediate-version
+    needs: [get-intermediate-version, changes]
+    if: ${{ needs.changes.outputs.ubuntu-build == 'true' }}
     uses: ./.github/workflows/build-and-test-deb.yaml
     permissions:
       id-token: write

.github/workflows/ci.yaml

@@ -26,23 +26,26 @@ on:
       - '**.go'
       - 'go.mod'
       - 'go.sum'
-      - '.github/workflows/e2e-macos.yaml'
-      - '.github/workflows/e2e-windows.yaml'
-      - '.github/workflows/e2e-linux.yaml'
-      - '.github/workflows/e2e-ubuntu.yaml'
       - 'contrib/packaging/**'
       - 'deps/**'
       - 'finch.yaml.d/**'
       - 'winres'
       - 'Makefile*'
       - '.golangci.yaml'
       - '!contrib/hello-finch/**'
+      - '.github/workflows/ci.yaml'
+      - '.github/workflows/e2e-macos.yaml'
+      - '.github/workflows/e2e-windows.yaml'
+      - '.github/workflows/e2e-linux.yaml'
+      - '.github/workflows/e2e-ubuntu.yaml'
+      - '.github/workflows/get-version-and-tag-for-ref.yaml'
   workflow_dispatch:
   workflow_call:
 
 permissions:
   id-token: write
   contents: write
+  pull-requests: read
 
 env:
   DEBUG: ${{ secrets.ACTIONS_STEP_DEBUG }}
@@ -53,6 +56,10 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  changes:
+    uses: ./.github/workflows/detect-changes.yaml
+    secrets: inherit
+  
   git-secrets:
     runs-on: ubuntu-latest
     timeout-minutes: 2
@@ -88,6 +95,8 @@ jobs:
         uses: "WyriHaximus/github-action-get-previous-tag@04e8485ecb6487243907e330d522ff60f02283ce" # v1.4.0
 
   gen-code-no-diff:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.code == 'true' }}
     strategy:
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
@@ -103,6 +112,8 @@ jobs:
       - run: git diff --exit-code
 
   unit-tests:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.code == 'true' }}
     strategy:
       fail-fast: false
       matrix:
@@ -123,6 +134,8 @@ jobs:
 
   # It's recommended to run golangci-lint in a job separate from other jobs (go test, etc) because different jobs run in parallel.
   go-linter:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.code == 'true' }}
     name: lint
     runs-on: ubuntu-latest
     timeout-minutes: 5
@@ -168,6 +181,8 @@ jobs:
         continue-on-error: true
 
   go-mod-tidy-check:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     timeout-minutes: 1
     steps:
@@ -179,6 +194,8 @@ jobs:
       - run: go mod tidy -diff
 
   check-licenses:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.code == 'true' || needs.changes.outputs.deps == 'true' }}
     runs-on: ubuntu-latest
     timeout-minutes: 1
     steps:
@@ -190,6 +207,8 @@ jobs:
       - run: make check-licenses
 
   macos-e2e-tests:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.mac-e2e == 'true' }}
     strategy:
       fail-fast: false
       matrix:
@@ -206,6 +225,8 @@ jobs:
       test-command: ${{ matrix.test-command }}
 
   windows-e2e-tests:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.win-e2e == 'true' }}
     strategy:
       fail-fast: false
       matrix:
@@ -220,6 +241,8 @@ jobs:
       test-command: ${{ matrix.test-command }}
 
   linux-e2e-tests:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.linux-e2e == 'true' }}
     strategy:
       fail-fast: false
       matrix:
@@ -236,6 +259,8 @@ jobs:
       runner-type: ${{ matrix.runner-type }}
 
   ubuntu-e2e-tests:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.ubuntu-e2e == 'true' }}
     strategy:
       fail-fast: false
       matrix:
@@ -252,6 +277,8 @@ jobs:
       output-arch: ${{ matrix.output-arch }}
 
   mdlint:
+    needs: [changes]
+    if: ${{ needs.changes.outputs.docs == 'true' }}
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:

.github/workflows/detect-changes.yaml

@@ -0,0 +1,111 @@
+name: Detect Changes
+on:
+  workflow_call:
+    inputs:
+      ref_name:
+        description: "The ref name. Defaults to github.head_ref if present, otherwise github.ref_name"
+        required: false
+        type: string
+    outputs:
+      code:
+        value: ${{ jobs.changes.outputs.code }}
+      docs:
+        value: ${{ jobs.changes.outputs.docs }}
+      deps:
+        value: ${{ jobs.changes.outputs.deps }}
+      mac-build:
+        value: ${{ jobs.changes.outputs.mac-build }}
+      mac-e2e:
+        value: ${{ jobs.changes.outputs.mac-e2e }}
+      win-build:
+        value: ${{ jobs.changes.outputs.win-build }}
+      win-e2e:
+        value: ${{ jobs.changes.outputs.win-e2e }}
+      ubuntu-build:
+        value: ${{ jobs.changes.outputs.ubuntu-build }}
+      ubuntu-e2e:
+        value: ${{ jobs.changes.outputs.ubuntu-e2e }}
+      linux-build:
+        value: ${{ jobs.changes.outputs.linux-build }}
+      linux-e2e:
+        value: ${{ jobs.changes.outputs.linux-e2e }}
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+      docs: ${{ steps.filter.outputs.docs }}
+      deps: ${{ steps.filter.outputs.deps }}
+      mac-build: ${{ steps.filter.outputs.mac-build }}
+      mac-e2e: ${{ steps.filter.outputs.mac-e2e }}
+      win-build: ${{ steps.filter.outputs.win-build }}
+      win-e2e: ${{ steps.filter.outputs.win-e2e }}
+      ubuntu-build: ${{ steps.filter.outputs.ubuntu-build }}
+      ubuntu-e2e: ${{ steps.filter.outputs.ubuntu-e2e }}
+      linux-build: ${{ steps.filter.outputs.linux-build }}
+      linux-e2e: ${{ steps.filter.outputs.linux-e2e }}
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          ref: ${{ inputs.ref_name || github.head_ref || github.ref_name }}
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          # predicate-quantifier: 'every'
+          list-files: 'csv'
+          filters: |
+            code: &code
+              - '**.go'
+              - 'go.mod'
+              - 'go.sum'
+              - 'Makefile*'
+              - 'finch.yaml.d/**'
+            docs:
+              - '**/*.md'
+            deps: &deps
+              - 'deps/**'
+            mac-build:
+              - *code
+              - *deps
+              - 'installer-builder/**'
+              - '.github/workflows/build-and-test-pkg.yaml'
+              - '.github/workflows/build-pkg.yaml'
+              - '.github/workflows/test-pkg.yaml'
+              - '.github/workflows/upload-installer-to-release.yaml'
+            mac-e2e:
+              - *code
+              - *deps
+              - '.github/workflows/e2e-macos.yaml'
+            win-build:
+              - *code
+              - *deps
+              - '.github/workflows/build-and-test-msi.yaml'
+              - '.github/workflows/upload-msi-to-release.yaml'
+              - 'winres/**'
+            win-e2e:
+              - *code
+              - *deps
+              - '.github/workflows/e2e-windows.yaml'
+            ubuntu-build:
+              - *code
+              - *deps
+              - 'contrib/packaging/deb/**'
+              - '.github/workflows/build-and-test-deb.yaml'
+              - '.github/workflows/upload-deb-to-release.yaml'
+            ubuntu-e2e:
+              - *code
+              - *deps
+              - 'contrib/packaging/deb/**'
+              - '.github/workflows/e2e-ubuntu.yaml'
+            linux-build: &linux-build
+              - *code
+              - *deps
+              - 'contrib/packaging/rpm/**'
+            linux-e2e:
+              - *linux-build
+              - '.github/workflows/e2e-linux.yaml'