Skip to content

Commit 146c4d8

Browse files
improve caching documentation (#468)
1 parent 56337c4 commit 146c4d8

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

Diff for: README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,14 @@ major versions: `12`, `14`, `16`
4141
more specific versions: `10.15`, `14.2.0`, `16.3.0`
4242
nvm lts syntax: `lts/erbium`, `lts/fermium`, `lts/*`
4343

44-
## Caching packages dependencies
44+
## Caching global packages data
4545

46-
The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under the hood for caching dependencies but requires less configuration settings. Supported package managers are `npm`, `yarn`, `pnpm` (v6.10+). The `cache` input is optional, and caching is turned off by default.
46+
The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under the hood for caching global packages data but requires less configuration settings. Supported package managers are `npm`, `yarn`, `pnpm` (v6.10+). The `cache` input is optional, and caching is turned off by default.
4747

4848
The action defaults to search for the dependency file (`package-lock.json` or `yarn.lock`) in the repository root, and uses its hash as a part of the cache key. Use `cache-dependency-path` for cases when multiple dependency files are used, or they are located in different subdirectories.
4949

50+
**Note:** The action does not cache `node_modules`
51+
5052
See the examples of using cache for `yarn` / `pnpm` and `cache-dependency-path` input in the [Advanced usage](docs/advanced-usage.md#caching-packages-dependencies) guide.
5153

5254
**Caching npm dependencies:**
@@ -101,7 +103,7 @@ jobs:
101103
1. [Check latest version](docs/advanced-usage.md#check-latest-version)
102104
2. [Using a node version file](docs/advanced-usage.md#node-version-file)
103105
3. [Using different architectures](docs/advanced-usage.md#architecture)
104-
4. [Caching packages dependencies](docs/advanced-usage.md#caching-packages-dependencies)
106+
4. [Caching packages data](docs/advanced-usage.md#caching-packages-dependencies)
105107
5. [Using multiple operating systems and architectures](docs/advanced-usage.md#multiple-operating-systems-and-architectures)
106108
6. [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm)
107109
7. [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn)

Diff for: docs/advanced-usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
- run: npm test
5656
```
5757

58-
## Caching packages dependencies
58+
## Caching packages data
5959
The action follows [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) guidelines, and caches global cache on the machine instead of `node_modules`, so cache can be reused between different Node.js versions.
6060

6161
**Caching yarn dependencies:**

0 commit comments

Comments
 (0)