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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,8 @@ See more examples on proper usage in [actions/cache documentation](https://githu
11
11
Integration of caching functionality into `actions/setup-node` action will bring the following benefits for action users:
12
12
- Decrease the entry threshold for using the cache for Node.js dependencies and simplify initial configuration
13
13
- Simplify YAML pipelines because no need additional steps to enable caching
14
+
- More users will use cache for Node.js so more customers will have fast builds!
14
15
15
-
As a result, more users will use the cache for Node.js builds and will be happy with fast builds.
16
16
As the first stage, we will add support for NPM dependencies caching. We can consider adding the same functionality for Yarn later.
17
17
18
18
We don't persue 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.
@@ -23,16 +23,16 @@ We don't persue the goal to provide wide customization of caching in scope of `a
23
23
-`''` - disable caching (default value)
24
24
- Potentially, we will be able to extend this input to support Yarn
25
25
- 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
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
28
- If input contains file path, action will use the specified file
29
-
- If input contains folder path, action will try to search `package.lock.json` file in the specified folder
29
+
- If input contains folder path, action will try to search `package-lock.json` file in the specified folder
30
30
- if input contains wildcards (like `**/package-lock.json`), hash of multiple files will be used
31
31
- 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)
32
32
- The following key cache will be used `${{ runner.os }}-npm-${{ hashFiles('<package-lock-path>') }}`
33
33
34
34
# Example of real use-cases
35
-
Default use case when `package.lock.json` or `yarn.lock` are located in repository root:
35
+
Default use case when `package-lock.json` or `yarn.lock` are located in repository root:
0 commit comments