mirror of
https://github.com/julia-actions/cache.git
synced 2026-02-12 17:36:53 +08:00
Compare commits
37 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
227b3767fc | ||
|
|
9a3120aab8 | ||
|
|
43522e389d | ||
|
|
e8472695fb | ||
|
|
2061bcf01c | ||
|
|
c4f371876b | ||
|
|
38850d7b75 | ||
|
|
429bb24537 | ||
|
|
8af8844cd0 | ||
|
|
424a20aa56 | ||
|
|
5dc38e58e3 | ||
|
|
05a577a682 | ||
|
|
8205b4547a | ||
|
|
509404de2a | ||
|
|
79b42d2cc0 | ||
|
|
2d7a7cc445 | ||
|
|
46d70a0fdf | ||
|
|
5aaa1e085e | ||
|
|
2c5c26f9c8 | ||
|
|
d9e495f279 | ||
|
|
d10a6fd8f3 | ||
|
|
1f7b6e036e | ||
|
|
c1893486c9 | ||
|
|
c231b4e8c0 | ||
|
|
e5a7946b4f | ||
|
|
9b3f75eff3 | ||
|
|
2b1bf4d8a1 | ||
|
|
49fd7c4af0 | ||
|
|
d343189aad | ||
|
|
315c171d17 | ||
|
|
f4098e6050 | ||
|
|
0c8892ce7f | ||
|
|
824243901f | ||
|
|
8608484607 | ||
|
|
e662c42397 | ||
|
|
e7913c2cb9 | ||
|
|
9ec3abbd64 |
12
.github/workflows/CI.yml
vendored
12
.github/workflows/CI.yml
vendored
@@ -59,7 +59,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
JULIA_DEPOT_PATH: /tmp/julia-depot
|
JULIA_DEPOT_PATH: /tmp/julia-depot
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- name: Set cache-name
|
- name: Set cache-name
|
||||||
id: cache-name
|
id: cache-name
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -117,7 +117,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
JULIA_DEPOT_PATH: /tmp/julia-depot
|
JULIA_DEPOT_PATH: /tmp/julia-depot
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- uses: julia-actions/setup-julia@v2
|
- uses: julia-actions/setup-julia@v2
|
||||||
with:
|
with:
|
||||||
version: ${{ matrix.version }}
|
version: ${{ matrix.version }}
|
||||||
@@ -161,7 +161,7 @@ jobs:
|
|||||||
outputs:
|
outputs:
|
||||||
cache-name: ${{ steps.cache-name.outputs.cache-name }}
|
cache-name: ${{ steps.cache-name.outputs.cache-name }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- name: Set cache-name
|
- name: Set cache-name
|
||||||
id: cache-name
|
id: cache-name
|
||||||
run: |
|
run: |
|
||||||
@@ -193,7 +193,7 @@ jobs:
|
|||||||
needs: test-save-nomatrix
|
needs: test-save-nomatrix
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- name: Restore cache
|
- name: Restore cache
|
||||||
id: cache
|
id: cache
|
||||||
uses: ./
|
uses: ./
|
||||||
@@ -233,7 +233,7 @@ jobs:
|
|||||||
outputs:
|
outputs:
|
||||||
cache-name: ${{ steps.cache-name.outputs.cache-name }}
|
cache-name: ${{ steps.cache-name.outputs.cache-name }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- name: Set cache-name
|
- name: Set cache-name
|
||||||
id: cache-name
|
id: cache-name
|
||||||
run: |
|
run: |
|
||||||
@@ -259,7 +259,7 @@ jobs:
|
|||||||
needs: test-save-cloned-registry
|
needs: test-save-cloned-registry
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
|
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
- name: Add General registry clone
|
- name: Add General registry clone
|
||||||
shell: julia --color=yes {0}
|
shell: julia --color=yes {0}
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
36
README.md
36
README.md
@@ -20,7 +20,7 @@ jobs:
|
|||||||
test:
|
test:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
- uses: julia-actions/setup-julia@v2
|
- uses: julia-actions/setup-julia@v2
|
||||||
- uses: julia-actions/cache@v2
|
- uses: julia-actions/cache@v2
|
||||||
- uses: julia-actions/julia-buildpkg@v1
|
- uses: julia-actions/julia-buildpkg@v1
|
||||||
@@ -51,6 +51,8 @@ By default all depot directories called out below are cached.
|
|||||||
### Outputs
|
### Outputs
|
||||||
|
|
||||||
- `cache-hit` - A boolean value to indicate an exact match was found for the primary key. Returns \"\" when the key is new. Forwarded from actions/cache.
|
- `cache-hit` - A boolean value to indicate an exact match was found for the primary key. Returns \"\" when the key is new. Forwarded from actions/cache.
|
||||||
|
- `cache-paths` - A list of paths (as a newline-separated string) that were cached.
|
||||||
|
- `cache-key` - The cache key that was used for this run.
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
@@ -64,6 +66,9 @@ By default, this action removes caches that were previously made by jobs on the
|
|||||||
GitHub automatically removes old caches after a certain period or when the repository cache allocation is full.
|
GitHub automatically removes old caches after a certain period or when the repository cache allocation is full.
|
||||||
It is, however, more efficient to explicitly remove old caches to improve caching for less frequently run jobs.
|
It is, however, more efficient to explicitly remove old caches to improve caching for less frequently run jobs.
|
||||||
|
|
||||||
|
For more information about GitHub caching generically, for example how to manually delete caches, see
|
||||||
|
[this GitHub documentation page](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows#managing-caches).
|
||||||
|
|
||||||
### Cache keys
|
### Cache keys
|
||||||
|
|
||||||
The cache key that the cache will be saved as is based on:
|
The cache key that the cache will be saved as is based on:
|
||||||
@@ -101,6 +106,35 @@ Which means your caches files will not grow needlessly. GitHub also deletes cach
|
|||||||
|
|
||||||
To disable deletion set input `delete-old-caches: 'false'`.
|
To disable deletion set input `delete-old-caches: 'false'`.
|
||||||
|
|
||||||
|
### Caching even if an intermediate job fails
|
||||||
|
|
||||||
|
Just like [the basic actions/cache workflow](https://github.com/actions/cache), this action has a cache restore step, and also a save step which runs after the workflow completes.
|
||||||
|
By default, if any job in the workflow fails, the entire workflow will be stopped, and the cache will not be saved.
|
||||||
|
|
||||||
|
Due to current limitations in GitHub Actions syntax, there is no built-in option for this action to save the cache even if the job fails.
|
||||||
|
However, it does output information which you can feed into `actions/cache` yourself to achieve the same effect.
|
||||||
|
For example, this workflow will ensure that the cache is saved if a step fails (but skipping it if the cache was hit, i.e. there's no need to cache it again).
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Load Julia packages from cache
|
||||||
|
id: julia-cache
|
||||||
|
uses: julia-actions/cache@v2
|
||||||
|
|
||||||
|
# do whatever you want here (that might fail)
|
||||||
|
|
||||||
|
- name: Save Julia depot cache on cancel or failure
|
||||||
|
id: julia-cache-save
|
||||||
|
if: cancelled() || failure()
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
${{ steps.julia-cache.outputs.cache-paths }}
|
||||||
|
key: ${{ steps.julia-cache.outputs.cache-key }}
|
||||||
|
```
|
||||||
|
|
||||||
### Cache Garbage Collection
|
### Cache Garbage Collection
|
||||||
|
|
||||||
Caches are restored and re-saved after every run, retaining the state of the depot throughout runs.
|
Caches are restored and re-saved after every run, retaining the state of the depot throughout runs.
|
||||||
|
|||||||
39
action.yml
39
action.yml
@@ -47,12 +47,18 @@ outputs:
|
|||||||
cache-hit:
|
cache-hit:
|
||||||
description: A boolean value to indicate an exact match was found for the primary key. Returns "" when the key is new. Forwarded from actions/cache.
|
description: A boolean value to indicate an exact match was found for the primary key. Returns "" when the key is new. Forwarded from actions/cache.
|
||||||
value: ${{ steps.hit.outputs.cache-hit }}
|
value: ${{ steps.hit.outputs.cache-hit }}
|
||||||
|
cache-paths:
|
||||||
|
description: The paths that were cached
|
||||||
|
value: ${{ steps.paths.outputs.cache-paths }}
|
||||||
|
cache-key:
|
||||||
|
description: The full cache key used
|
||||||
|
value: ${{ steps.keys.outputs.key }}
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'composite'
|
using: 'composite'
|
||||||
steps:
|
steps:
|
||||||
- name: Install jq
|
- name: Install jq
|
||||||
uses: dcarbone/install-jq-action@8867ddb4788346d7c22b72ea2e2ffe4d514c7bcb
|
uses: dcarbone/install-jq-action@b7ef57d46ece78760b4019dbc4080a1ba2a40b45 # v3.2.0
|
||||||
with:
|
with:
|
||||||
force: false # Skip install when an existing `jq` is present
|
force: false # Skip install when an existing `jq` is present
|
||||||
|
|
||||||
@@ -66,6 +72,12 @@ runs:
|
|||||||
else
|
else
|
||||||
depot="~/.julia"
|
depot="~/.julia"
|
||||||
fi
|
fi
|
||||||
|
if [[ "$OSTYPE" == "msys" || "$OSTYPE" == "cygwin" ]]; then
|
||||||
|
depot="${depot/#\~/$USERPROFILE}" # Windows paths
|
||||||
|
depot="${depot//\\//}" # Replace backslashes with forward slashes
|
||||||
|
else
|
||||||
|
depot="${depot/#\~/$HOME}" # Unix-like paths
|
||||||
|
fi
|
||||||
echo "depot=$depot" | tee -a "$GITHUB_OUTPUT"
|
echo "depot=$depot" | tee -a "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
cache_paths=()
|
cache_paths=()
|
||||||
@@ -75,7 +87,7 @@ runs:
|
|||||||
[ "${{ inputs.cache-packages }}" = "true" ] && cache_paths+=("$packages_path")
|
[ "${{ inputs.cache-packages }}" = "true" ] && cache_paths+=("$packages_path")
|
||||||
registries_path="${depot}/registries"
|
registries_path="${depot}/registries"
|
||||||
if [ "${{ inputs.cache-registries }}" = "true" ]; then
|
if [ "${{ inputs.cache-registries }}" = "true" ]; then
|
||||||
if [ ! -d "${registries_path/#\~/$HOME}" ]; then
|
if [ ! -d "${registries_path}" ]; then
|
||||||
cache_paths+=("$registries_path")
|
cache_paths+=("$registries_path")
|
||||||
else
|
else
|
||||||
echo "::warning::Julia depot registries already exist. Skipping restoring of cached registries to avoid potential merge conflicts when updating. Please ensure that \`julia-actions/cache\` precedes any workflow steps which add registries."
|
echo "::warning::Julia depot registries already exist. Skipping restoring of cached registries to avoid potential merge conflicts when updating. Please ensure that \`julia-actions/cache\` precedes any workflow steps which add registries."
|
||||||
@@ -115,7 +127,7 @@ runs:
|
|||||||
env:
|
env:
|
||||||
MATRIX_JSON: ${{ toJSON(matrix) }}
|
MATRIX_JSON: ${{ toJSON(matrix) }}
|
||||||
|
|
||||||
- uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
|
- uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
|
||||||
id: cache
|
id: cache
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
@@ -132,6 +144,23 @@ runs:
|
|||||||
du -shc ${{ steps.paths.outputs.depot }}/* || true
|
du -shc ${{ steps.paths.outputs.depot }}/* || true
|
||||||
shell: bash
|
shell: bash
|
||||||
|
|
||||||
|
# issue https://github.com/julia-actions/cache/issues/110
|
||||||
|
# Pkg may not run `Registry.update()` if a manifest exists, which may exist because of a
|
||||||
|
# `Pkg.dev` call or because one is added to the repo. So be safe and update cached registries here.
|
||||||
|
# Older (~v1.0) versions of julia that don't have `Pkg.Registry.update()` seem to always update registries in
|
||||||
|
# Pkg operations. So this is only necessary for newer julia versions.
|
||||||
|
- name: Update any cached registries
|
||||||
|
if: ${{ inputs.cache-registries == 'true' }}
|
||||||
|
continue-on-error: true
|
||||||
|
run: |
|
||||||
|
if [ -d "${{ steps.paths.outputs.depot }}/registries" ] && [ -n "$(ls -A "${{ steps.paths.outputs.depot }}/registries")" ]; then
|
||||||
|
echo "Registries directory exists and is non-empty. Updating any registries"
|
||||||
|
julia -e "import Pkg; isdefined(Pkg, :Registry) && Pkg.Registry.update();"
|
||||||
|
else
|
||||||
|
echo "Registries directory does not exist or is empty. Skipping registry update"
|
||||||
|
fi
|
||||||
|
shell: bash
|
||||||
|
|
||||||
# GitHub actions cache entries are immutable and cannot be updated. In order to have both the Julia
|
# GitHub actions cache entries are immutable and cannot be updated. In order to have both the Julia
|
||||||
# depot cache be up-to-date and avoid storing redundant cache entries we'll manually cleanup old
|
# depot cache be up-to-date and avoid storing redundant cache entries we'll manually cleanup old
|
||||||
# cache entries before the new cache is saved. However, we need to be careful with our manual
|
# cache entries before the new cache is saved. However, we need to be careful with our manual
|
||||||
@@ -149,7 +178,7 @@ runs:
|
|||||||
# - https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
|
# - https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
|
||||||
|
|
||||||
# Not windows
|
# Not windows
|
||||||
- uses: pyTooling/Actions/with-post-step@e9d0dc3dba9fda45f195946858708f60c0240caf # v1.0.5
|
- uses: pyTooling/Actions/with-post-step@370c306306304663febee1525552a09e061588fa # v7.4.2
|
||||||
if: ${{ inputs.delete-old-caches != 'false' &&
|
if: ${{ inputs.delete-old-caches != 'false' &&
|
||||||
github.ref != format('refs/heads/{0}', github.event.repository.default_branch) &&
|
github.ref != format('refs/heads/{0}', github.event.repository.default_branch) &&
|
||||||
runner.OS != 'Windows' }}
|
runner.OS != 'Windows' }}
|
||||||
@@ -162,7 +191,7 @@ runs:
|
|||||||
GH_TOKEN: ${{ inputs.token }}
|
GH_TOKEN: ${{ inputs.token }}
|
||||||
|
|
||||||
# Windows (because this action uses command prompt on windows)
|
# Windows (because this action uses command prompt on windows)
|
||||||
- uses: pyTooling/Actions/with-post-step@e9d0dc3dba9fda45f195946858708f60c0240caf # v1.0.5
|
- uses: pyTooling/Actions/with-post-step@370c306306304663febee1525552a09e061588fa # v7.4.2
|
||||||
if: ${{ inputs.delete-old-caches != 'false' &&
|
if: ${{ inputs.delete-old-caches != 'false' &&
|
||||||
github.ref != format('refs/heads/{0}', github.event.repository.default_branch) &&
|
github.ref != format('refs/heads/{0}', github.event.repository.default_branch) &&
|
||||||
runner.OS == 'Windows' }}
|
runner.OS == 'Windows' }}
|
||||||
|
|||||||
Reference in New Issue
Block a user