[CI] Only run GitHub Actions workflows when relevant (#2568)

* [CI] Only run GitHub Actions workflows when relevant

* Add examples path to documentation workflow triggers

Author: giordano

.github/workflows/CI.yml

@@ -1,10 +1,24 @@
 name: CI
 on:
   pull_request:
+    paths:
+      - '.github/workflows/CI.yml'
+      - 'ext/**'
+      - 'lib/**'
+      - 'src/**'
+      - 'test/**'
+      - 'Project.toml'
   push:
     branches:
       - main
       - release-*
+    paths:
+      - '.github/workflows/CI.yml'
+      - 'ext/**'
+      - 'lib/**'
+      - 'src/**'
+      - 'test/**'
+      - 'Project.toml'
     tags: '*'
 
 concurrency:
@@ -230,29 +244,3 @@ jobs:
           files: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: false  # or true if you want CI to fail when Codecov fails
-  docs:
-    timeout-minutes: 20
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: '1'
-      - uses: julia-actions/cache@v2
-      - run: |
-          julia --color=yes --project=docs -e '
-            using Pkg
-            Pkg.instantiate()'
-        env:
-          JULIA_PKG_SERVER_REGISTRY_PREFERENCE: eager
-      - run: |
-          julia --color=yes --project=docs -e '
-            using Documenter: DocMeta, doctest
-            using Enzyme
-            DocMeta.setdocmeta!(Enzyme, :DocTestSetup, :(using Enzyme); recursive=true)
-            doctest(Enzyme)'
-      - run: julia --color=yes --project=docs docs/make.jl
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/Documentation.yml

@@ -0,0 +1,66 @@
+name: Documentation
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/Documentation.yml'
+      - 'docs/**'
+      - 'examples/**'
+      - 'lib/**'
+      - 'src/**'
+      - 'Project.toml'
+  push:
+    branches:
+      - main
+      - release-*
+    paths:
+      - '.github/workflows/Documentation.yml'
+      - 'docs/**'
+      - 'examples/**'
+      - 'lib/**'
+      - 'src/**'
+      - 'Project.toml'
+    tags: '*'
+
+concurrency:
+  # Same group concurrency as the `PreviewCleanup.yml` workflow, because they both
+  # git-push to the same branch, so we want to avoid clashes.  NOTE: this is
+  # different from the concurrency group below, which is to cancel successive
+  # jobs from within the PR.
+  group: docs-pushing
+
+jobs:
+  docs:
+    timeout-minutes: 20
+    name: Documentation
+    runs-on: ubuntu-latest
+    concurrency:
+      # Skip intermediate builds: always.
+      # Cancel intermediate builds: only if it is a pull request build.
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - name: Instantiate docs environment
+        shell: julia --color=yes --project=docs {0}
+        run: |
+          using Pkg
+          Pkg.instantiate()
+        env:
+          JULIA_PKG_SERVER_REGISTRY_PREFERENCE: eager
+      - name: Run doctests
+        shell: julia --color=yes --project=docs {0}
+        run: |
+          using Documenter: DocMeta, doctest
+          using Enzyme
+          DocMeta.setdocmeta!(Enzyme, :DocTestSetup, :(using Enzyme); recursive=true)
+          doctest(Enzyme)
+      - name: Build the docs
+        run: julia --color=yes --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/PreviewCleanup.yml

@@ -4,6 +4,11 @@ on:
   pull_request:
     types: [closed]
 
+concurrency:
+  # Same group concurrency as the `Documentation.yml` workflow, because they both
+  # git-push to the same branch, so we want to avoid clashes.
+  group: docs-pushing
+
 jobs:
   doc-preview-cleanup:
     runs-on: ubuntu-latest

.github/workflows/benchmark_pr.yml

@@ -2,6 +2,14 @@ name: Benchmark a pull request
 
 on:
   pull_request:
+    paths:
+      - '.github/workflows/benchmark_pr.yml'
+      - 'benchmark/**'
+      - 'ext/**'
+      - 'lib/**'
+      - 'src/**'
+      - 'test/**'
+      - 'Project.toml'
 
 permissions:
   pull-requests: write