julia-actions/cache
1
0
Fork 0
mirror of https://github.com/julia-actions/cache.git synced 2026-02-12 01:16:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation consistency fixes (#84)

Browse Source 
* Consistent use of periods

* Consistent casing of GitHub

* Use 2-space indentation for YAML example

* Add links to for further details
This commit is contained in:
Curtis Vogt
2024-01-02 20:59:12 -06:00
committed by GitHub
parent ff08d7d467
commit 930a18227b
2 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -47,8 +47,8 @@ However note that caching the registries may mean that the registry will not be
- `cache-compiled` - Whether to cache `~/.julia/compiled/`. Defaults to `true`. - `cache-compiled` - Whether to cache `~/.julia/compiled/`. Defaults to `true`.
- `cache-scratchspaces` - Whether to cache `~/.julia/scratchspaces/`. Defaults to `true`. - `cache-scratchspaces` - Whether to cache `~/.julia/scratchspaces/`. Defaults to `true`.
- `cache-logs` - Whether to cache `~/.julia/logs/`. Defaults to `true`. Helps auto-`Pkg.gc()` keep the cache small. - `cache-logs` - Whether to cache `~/.julia/logs/`. Defaults to `true`. Helps auto-`Pkg.gc()` keep the cache small.
- `delete-old-caches` - Whether to delete old caches for the given key. Defaults to `true` - `delete-old-caches` - Whether to delete old caches for the given key. Defaults to `true`.
- `token` - A github PAT. Defaults to `github.token`. Requires `repo` scope to enable the deletion of old caches. - `token` - A [GitHub PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). Defaults to `github.token`. Requires `repo` scope to enable the deletion of old caches.
### Outputs ### Outputs
@@ -82,13 +82,13 @@ This action automatically deletes old caches that match the first 4 fields of th
- All variables in the `matrix` (unless disabled via `include-matrix: 'false'`) - All variables in the `matrix` (unless disabled via `include-matrix: 'false'`)
- The `runner.os` (may be in the matrix too, but included for safety) - The `runner.os` (may be in the matrix too, but included for safety)
Which means your caches files will not grow needlessly. Github also deletes cache files after Which means your caches files will not grow needlessly. GitHub also deletes cache files after
[90 days which can be increased in private repos to up to 400 days](https://docs.github.com/en/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization) [90 days which can be increased in private repos to up to 400 days](https://docs.github.com/en/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)
> [!NOTE] > [!NOTE]
> To allow deletion of caches you will likely need to grant the following to the default > To allow deletion of caches you will likely need to [grant the following permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs)
> `GITHUB_TOKEN` by adding this to your yml: > to the `GITHUB_TOKEN` by adding this to your GitHub actions workflow:
> ``` > ```yaml
> permissions: > permissions:
> actions: write > actions: write
> contents: read > contents: read

18
action.yml
View File

@@ -11,31 +11,31 @@ inputs:
description: 'The cache key prefix. Unless disabled the key body automatically includes matrix vars, and the OS. Include any other parameters/details in this prefix to ensure one unique cache key per concurrent job type.' description: 'The cache key prefix. Unless disabled the key body automatically includes matrix vars, and the OS. Include any other parameters/details in this prefix to ensure one unique cache key per concurrent job type.'
default: 'julia-cache-${{ github.workflow }}-${{ github.job }}' default: 'julia-cache-${{ github.workflow }}-${{ github.job }}'
include-matrix: include-matrix:
description: 'Whether to include the matrix values when constructing the cache key' description: 'Whether to include the matrix values when constructing the cache key.'
default: 'true' default: 'true'
cache-artifacts: cache-artifacts:
description: 'Whether to cache ~/.julia/artifacts/' description: 'Whether to cache ~/.julia/artifacts/.'
default: 'true' default: 'true'
cache-packages: cache-packages:
description: 'Whether to cache ~/.julia/packages/' description: 'Whether to cache ~/.julia/packages/.'
default: 'true' default: 'true'
cache-registries: cache-registries:
description: 'Whether to cache ~/.julia/registries/. This is off by default to ensure CI gets latest versions' description: 'Whether to cache ~/.julia/registries/. This is off by default to ensure CI gets latest versions.'
default: 'false' default: 'false'
cache-compiled: cache-compiled:
description: 'Whether to cache ~/.julia/compiled/' description: 'Whether to cache ~/.julia/compiled/.'
default: 'true' default: 'true'
cache-scratchspaces: cache-scratchspaces:
description: 'Whether to cache ~/.julia/scratchspaces/' description: 'Whether to cache ~/.julia/scratchspaces/.'
default: 'true' default: 'true'
cache-logs: cache-logs:
description: 'Whether to cache ~/.julia/logs/. This helps automatic Pkg.gc() keep the cache size down' description: 'Whether to cache ~/.julia/logs/. This helps automatic Pkg.gc() keep the cache size down.'
default: 'true' default: 'true'
delete-old-caches: delete-old-caches:
description: 'Whether to delete old caches for the given key' description: 'Whether to delete old caches for the given key.'
default: 'true' default: 'true'
token: token:
description: 'A github PAT. Requires `repo` scope to enable the deletion of old caches' description: 'A GitHub PAT. Requires `repo` scope to enable the deletion of old caches.'
default: '${{ github.token }}' default: '${{ github.token }}'
outputs: outputs: