actions/setup-node
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update 0000-caching-dependencies.md

Browse source
This commit is contained in:
Maxim Lobanov 2021-05-21 18:28:06 +03:00
parent 24265e14d4
commit 8c35c6c880
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/adrs/0000-caching-dependencies.md
View file

@ -11,8 +11,8 @@ See more examples on proper usage in [actions/cache documentation](https://githu
Integration of caching functionality into `actions/setup-node` action will bring the following benefits for action users: Integration of caching functionality into `actions/setup-node` action will bring the following benefits for action users:
- Decrease the entry threshold for using the cache for Node.js dependencies and simplify initial configuration - Decrease the entry threshold for using the cache for Node.js dependencies and simplify initial configuration
- Simplify YAML pipelines because no need additional steps to enable caching - Simplify YAML pipelines because no need additional steps to enable caching
- More users will use cache for Node.js so more customers will have fast builds!
As a result, more users will use the cache for Node.js builds and will be happy with fast builds.
As the first stage, we will add support for NPM dependencies caching. We can consider adding the same functionality for Yarn later. As the first stage, we will add support for NPM dependencies caching. We can consider adding the same functionality for Yarn later.
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. 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
- `''` - disable caching (default value) - `''` - disable caching (default value)
- Potentially, we will be able to extend this input to support Yarn - Potentially, we will be able to extend this input to support Yarn
- 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`) - 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`)
- Add optional input `package-lock-path` that will allow to specify path to `package.lock.json` file path: - Add optional input `package-lock-path` that will allow to specify path to `package-lock.json` file path:
- 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 - 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
- If input contains file path, action will use the specified file - If input contains file path, action will use the specified file
- If input contains folder path, action will try to search `package.lock.json` file in the specified folder - If input contains folder path, action will try to search `package-lock.json` file in the specified folder
- if input contains wildcards (like `**/package-lock.json`), hash of multiple files will be used - if input contains wildcards (like `**/package-lock.json`), hash of multiple files will be used
- 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) - 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)
- The following key cache will be used `${{ runner.os }}-npm-${{ hashFiles('<package-lock-path>') }}` - The following key cache will be used `${{ runner.os }}-npm-${{ hashFiles('<package-lock-path>') }}`
# Example of real use-cases # Example of real use-cases
Default use case when `package.lock.json` or `yarn.lock` are located in repository root: Default use case when `package-lock.json` or `yarn.lock` are located in repository root:
```yml ```yml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2