actions/cache
1
0
Fork 0
mirror of https://code.forgejo.org/actions/cache.git synced 2025-04-20 15:53:59 +08:00
Code Issues Projects Releases Packages Wiki Activity

Rewrite readmes (#1085)

Browse source 
* Improve readmes

* Add markdown for default value

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>

---------

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
This commit is contained in:
Josh Soref 2023-01-31 05:31:15 -05:00 • committed by GitHub
parent 627f0f41f6
commit 22d3da765b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 66 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

8
examples.md
View file

@ -68,7 +68,7 @@ With `actions/cache@v3` you can now exclude unwanted packages with [exclude patt
```
Or you could move the cache folder like below.
>Note: This workflow does not work for projects that require files to be placed in user profile package folder
> **Note** This workflow does not work for projects that require files to be placed in user profile package folder
```yaml
env:
@ -280,7 +280,7 @@ We cache the elements of the Cabal store separately, as the entirety of `~/.caba
## Java - Gradle
>Note: Ensure no Gradle daemons are running anymore when your workflow completes. Creating the cache package might fail due to locks being held by Gradle. Refer to the [Gradle Daemon documentation](https://docs.gradle.org/current/userguide/gradle_daemon.html) on how to disable or stop the Gradle Daemons.
> **Note** Ensure no Gradle daemons are running anymore when your workflow completes. Creating the cache package might fail due to locks being held by Gradle. Refer to the [Gradle Daemon documentation](https://docs.gradle.org/current/userguide/gradle_daemon.html) on how to disable or stop the Gradle Daemons.
```yaml
- uses: actions/cache@v3
@ -312,7 +312,7 @@ For npm, cache files are stored in `~/.npm` on Posix, or `~\AppData\npm-cache` o
If using `npm config` to retrieve the cache directory, ensure you run [actions/setup-node](https://github.com/actions/setup-node) first to ensure your `npm` version is correct.
After [deprecation](https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/) of save-state and set-output commands, the correct way to set output is using `${GITHUB_OUTPUT}`. For linux, we can use `${GITHUB_OUTPUT}` whereas for windows we need to use `${env:GITHUB_OUTPUT}` due to two different default shells in these two different OS ie `bash` and `pwsh` respectively.
>Note: It is not recommended to cache `node_modules`, as it can break across Node versions and won't work with `npm ci`
> **Note** It is not recommended to cache `node_modules`, as it can break across Node versions and won't work with `npm ci`
### **Get npm cache directory using same shell**
### Bash shell
@ -508,7 +508,7 @@ jobs:
### Using pip to get cache location
> Note: This requires pip 20.1+
> **Note** This requires pip 20.1+
```yaml
- name: Get pip cache dir
id: pip-cache