Consistent caching in GitHub workflows (#162)

abelsiqueira · May 30, 2024 · e878be5 · e878be5
1 parent acfa3b0
commit e878be5
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 22 deletions.
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
@@ -24,6 +24,8 @@ jobs:
           version: "1"
           arch: ${{ runner.arch }}
         if: steps.julia_in_path.outcome != 'success'
+      - name: Use Julia cache
+        uses: julia-actions/cache@v2
       - name: "Add the General registry via Git"
         run: |
           import Pkg

diff --git a/.github/workflows/Copier.yml b/.github/workflows/Copier.yml
@@ -21,6 +21,8 @@ jobs:
         run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
       - name: Setup Python
         uses: actions/setup-python@v5
+        with:
+          cache: pip
       - name: Check for update in the template
         run: |
           pip install copier

diff --git a/.github/workflows/Docs.yml b/.github/workflows/Docs.yml
@@ -33,6 +33,8 @@ jobs:
       - uses: julia-actions/setup-julia@v2
         with:
           version: "1"
+      - name: Use Julia cache
+        uses: julia-actions/cache@v2
       - run: |
           julia --project=docs -e '
             using Pkg

diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml
@@ -30,6 +30,13 @@ jobs:
         run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
       - name: Setup Python
         uses: actions/setup-python@v5
+        with:
+          cache: pip
+      - name: Cache pre-commit
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('**/.pre-commit-config.yaml') }}
       - name: Install pre-commit
         run: pip install pre-commit
       - name: Run pre-commit

diff --git a/.github/workflows/Test.yml b/.github/workflows/Test.yml
@@ -51,16 +51,8 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v4
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - name: Use Julia cache
+        uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning].
 
 - More reader-friendly README (#144)
 - Add author names to licenses (#145)
+- Consistent caching in GitHub workflows (#53)
 
 ## [0.3.1] - 2024-05-23
 

diff --git a/template/.github/workflows/CompatHelper.yml b/template/.github/workflows/CompatHelper.yml
@@ -3,7 +3,7 @@ name: CompatHelper
 
 on:
   schedule:
-    - cron: 0 0 * * *
+    - cron: 0 0 * * * # Every day at 00:00 UTC
   workflow_dispatch:
 
 permissions:
@@ -24,6 +24,8 @@ jobs:
           version: "1"
           arch: ${{ runner.arch }}
         if: steps.julia_in_path.outcome != 'success'
+      - name: Use Julia cache
+        uses: julia-actions/cache@v2
       - name: "Add the General registry via Git"
         run: |
           import Pkg

diff --git a/template/.github/workflows/Copier.yml.jinja b/template/.github/workflows/Copier.yml.jinja
@@ -2,7 +2,7 @@
 
 on:
   schedule:
-    - cron: 0 7 1/7 * *
+    - cron: 0 7 1/7 * *  # Every 7 days at 7:00 UTC
   workflow_dispatch:
 
 jobs:
@@ -21,6 +21,8 @@ jobs:
         run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
       - name: Setup Python
         uses: actions/setup-python@v5
+        with:
+          cache: 'pip'
       - name: Check for update in the template
         run: |
           pip install copier

diff --git a/template/.github/workflows/Docs.yml.jinja b/template/.github/workflows/Docs.yml.jinja
@@ -33,6 +33,8 @@ jobs:
       - uses: julia-actions/setup-julia@v2
         with:
           version: "1"
+      - name: Use Julia cache
+        uses: julia-actions/cache@v2
       - run: |
           julia --project=docs -e '
             using Pkg

diff --git a/template/.github/workflows/Lint.yml b/template/.github/workflows/Lint.yml
@@ -30,6 +30,13 @@ jobs:
         run: julia -e 'using Pkg; pkg"add JuliaFormatter"'
       - name: Setup Python
         uses: actions/setup-python@v5
+        with:
+          cache: "pip"
+      - name: Cache pre-commit
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('**/.pre-commit-config.yaml') }}
       - name: Install pre-commit
         run: pip install pre-commit
       - name: Run pre-commit

diff --git a/template/.github/workflows/Test.yml.jinja b/template/.github/workflows/Test.yml.jinja
@@ -61,16 +61,9 @@ jobs:
         {% raw %}with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v4
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-{% endraw %}
+        {% endraw %}
+      - name: Use Julia cache
+        uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1