Skip to content

Commit 8c35c6c

Browse files
author
Maxim Lobanov
committed
Update 0000-caching-dependencies.md
1 parent 24265e1 commit 8c35c6c

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/adrs/0000-caching-dependencies.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ See more examples on proper usage in [actions/cache documentation](https://githu
1111
Integration of caching functionality into `actions/setup-node` action will bring the following benefits for action users:
1212
- Decrease the entry threshold for using the cache for Node.js dependencies and simplify initial configuration
1313
- 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!
1415

15-
As a result, more users will use the cache for Node.js builds and will be happy with fast builds.
1616
As the first stage, we will add support for NPM dependencies caching. We can consider adding the same functionality for Yarn later.
1717

1818
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
2323
- `''` - disable caching (default value)
2424
- Potentially, we will be able to extend this input to support Yarn
2525
- 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
2828
- 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
3030
- if input contains wildcards (like `**/package-lock.json`), hash of multiple files will be used
3131
- 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)
3232
- The following key cache will be used `${{ runner.os }}-npm-${{ hashFiles('<package-lock-path>') }}`
3333

3434
# 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:
3636
```yml
3737
steps:
3838
- uses: actions/checkout@v2

0 commit comments

Comments
 (0)