chore(ci): Only run workflows pertaining to the part of the codebase …

…that changed (#789)
informalsystems · Jan 21, 2025 · 4b64acc · 4b64acc
1 parent f044fe2
commit 4b64acc
Show file tree

Hide file tree

Showing 5 changed files with 114 additions and 37 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -4,10 +4,6 @@ on:
   push:
     branches: main
   pull_request:
-    paths:
-      - code/**
-      - specs/quint/**
-      - .github/workflows/coverage.yml
 
 env:
   CARGO_TERM_COLOR: always
@@ -19,8 +15,28 @@ env:
   RUSTUP_MAX_RETRIES: 10
 
 jobs:
+  changes:
+    name: Detect changes
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+      specs: ${{ steps.filter.outputs.specs }}
+    steps:
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - 'code/**'
+            specs:
+              - 'specs/**'
+
   integration:
     name: Integration
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -31,7 +47,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Install Protoc
-        uses: arduino/setup-protoc@v3
+        uses: arduino/setup-protoc@v
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Setup Node
@@ -75,6 +91,8 @@ jobs:
 
   mbt:
     name: MBT
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' || needs.changes.outputs.specs == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -2,11 +2,7 @@ name: Docs
 
 on:
   push:
-    branches:
-      - main
-    paths:
-      - code/**
-      - .github/workflows/todo-tracking.yml
+    branches: main
 
 permissions:
   contents: read
@@ -18,8 +14,25 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
+  changes:
+    name: Detect changes
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+    steps:
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - 'code/**'
+
   build:
     name: Build
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -53,11 +66,11 @@ jobs:
 
   deploy:
     name: Deploy
+    runs-on: ubuntu-latest
+    needs: build
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/.github/workflows/mbt.yml b/.github/workflows/mbt.yml
@@ -1,21 +1,32 @@
 name: MBT
 on:
   push:
-    branches:
-      - main
-    paths:
-      - specs/quint/**
-      - code/**
-      - .github/workflows/mbt.yml
+    branches: main
   pull_request:
-    paths:
-      - specs/quint/**
-      - code/**
-      - .github/workflows/mbt.yml
 
 jobs:
+  changes:
+    name: Detect changes
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+      specs: ${{ steps.filter.outputs.specs }}
+    steps:
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - 'code/**'
+            specs:
+              - 'specs/**'
+
   mbt-tests:
     name: Run MBT Tests
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' || needs.changes.outputs.specs == 'true' }}
     runs-on: ubuntu-latest
     env:
       CARGO_INCREMENTAL: 0

diff --git a/.github/workflows/quint.yml b/.github/workflows/quint.yml
@@ -1,19 +1,31 @@
 on:
   workflow_dispatch:
   push:
-    branches:
-      - main
-    paths:
-      - specs/**/*.qnt
+    branches: main
   pull_request:
-    paths:
-      - specs/**/*.qnt
 
 name: Quint
 
 jobs:
+  changes:
+    name: Detect changes
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    outputs:
+      specs: ${{ steps.filter.outputs.specs }}
+    steps:
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            specs:
+              - 'specs/**'
+
   quint-typecheck:
     name: Typecheck
+    needs: changes
+    if: ${{ needs.changes.outputs.specs == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -25,6 +37,8 @@ jobs:
 
   quint-test:
     name: Test
+    needs: changes
+    if: ${{ needs.changes.outputs.specs == 'true' }}
     runs-on: ubuntu-latest
     env:
       MAX_SAMPLES: 100

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -3,15 +3,7 @@ name: Rust
 on:
   push:
     branches: main
-    paths:
-      - code/**
-      - specs/quint/**
-      - .github/workflows/rust.yml
   pull_request:
-    paths:
-      - code/**
-      - specs/quint/**
-      - .github/workflows/rust.yml
 
 env:
   CARGO_INCREMENTAL: 0
@@ -23,8 +15,25 @@ env:
   RUSTUP_MAX_RETRIES: 10
 
 jobs:
+  changes:
+    name: Detect changes
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+    steps:
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            code:
+              - 'code/**'
+
   test:
     name: Unit Tests
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -60,6 +69,8 @@ jobs:
 
   integration:
     name: Integration Tests
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -95,6 +106,8 @@ jobs:
 
   no_std:
     name: no_std compatibility
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -108,14 +121,16 @@ jobs:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Setup Rust toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
-        with: 
+        with:
           cache-workspaces: "code"
           target: thumbv7m-none-eabi
       - name: Check no_std compatibility
         run: cargo build --target thumbv7m-none-eabi -p informalsystems-malachitebft-peer
 
   clippy:
     name: Clippy
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -137,6 +152,8 @@ jobs:
 
   fmt:
     name: Formatting
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -153,6 +170,8 @@ jobs:
 
   msrv:
     name: MSRV
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -176,6 +195,8 @@ jobs:
 
   standalone:
     name: Standalone
+    needs: changes
+    if: ${{ needs.changes.outputs.code == 'true' }}
     runs-on: ubuntu-latest
     defaults:
       run: