You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/adrs/0000-caching-dependencies.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,26 +13,27 @@ Integration of caching functionality into `actions/setup-node` action will bring
13
13
- Simplify YAML pipelines because no need additional steps to enable caching
14
14
- More users will use cache for Node.js so more customers will have fast builds!
15
15
16
-
As the first stage, we will add support for NPM dependencies caching. We can consider adding the same functionality for Yarn later.
16
+
We will add support for NPM and Yarn dependencies caching.
17
+
As the first stage, we won't support custom locations for `package-lock.json`, `yarn.lock` files and action will work only when files are located in repository root.
17
18
18
19
We don't pursue the goal to provide wide customization of caching in scope of `actions/setup-node` action. The purpose of this integration is covering ~90% of basic use-cases. If user needs flexible customization, we should advice them to use `actions/cache` directly.
19
20
20
21
# Decision
21
22
- Add `cache` input parameter to `actions/setup-node`. For now, input will accept the following values:
22
23
-`npm` - enable caching for npm dependencies
24
+
-`yarn` - enable caching for yarn dependencies
23
25
-`''` - disable caching (default value)
24
-
- Potentially, we will be able to extend this input to support Yarn
25
26
- Cache feature will be disabled by default to make sure that we don't break existing customers. We will consider enabling cache by default in next major release (`v3`)
26
-
- Add optional input `package-lock-path` that will allow to specify path to `package-lock.json` file path:
27
-
- If input is not defined, action will try to search `package-lock.json` or `yarn.lock` (npm 7.x supports `yarn.lock` files) files in the repository root and throw error if no one is found
28
-
- If input contains file path, action will use the specified file
29
-
- if input contains wildcards (like `**/package-lock.json`), hash of multiple files will be used
30
-
- The hash of file provided in `package-lock-path` input will be used as cache key (the same approach like [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) recommends)
27
+
- Action will try to search `package-lock.json` or `yarn.lock` (npm 7.x supports `yarn.lock` files) files in the repository root and throw error if no one is found
28
+
- The hash of found file will be used as cache key (the same approach like [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) recommends)
31
29
- The following key cache will be used `${{ runner.os }}-npm-${{ hashFiles('<package-lock-path>') }}`
32
-
- Action will cache global npm cache directory (retrieved via `npm config get cache`)
30
+
- Action will cache global cache:
31
+
- Npm (retrieved via `npm config get cache`)
32
+
- Yarn 1 (retrieved via `yarn cache dir`)
33
+
- Yarn 2 (retrieved via `yarn config get cacheFolder`)
33
34
34
35
# Example of real use-cases
35
-
Default use case when `package-lock.json` or `yarn.lock` are located in repository root:
0 commit comments