actions/setup-node
1
0
Fork 0
mirror of https://github.com/actions/setup-node.git synced 2025-12-25 09:47:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update lockfile documenation

Browse source
This commit is contained in:
mahabaleshwars 2025-12-08 17:42:53 +05:30
commit be6bbe7bfc
6 changed files with 36 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/advanced-usage.md
View file

@ -7,8 +7,6 @@ Most supported package managers recommend that you **always** commit the lockfi
- Provides a facility for users to "time-travel" to previous states of `node_modules` without having to commit the directory itself.
- Facilitates greater visibility of tree changes through readable source control diffs.
**However, for libraries, not using a lockfile may be preferable to ensure testing with the latest transitive dependencies. See the [Node.js Package Maintenance Working Group documentation on dependency management guidelines](https://github.com/nodejs/package-maintenance/blob/main/docs/dependency-management-guidelines.md#using-lockfiles) for a discussion of tradeoffs.**
In order to get the most out of using your lockfile on continuous integration follow the conventions outlined below for your respective package manager.
### NPM
@ -43,7 +41,7 @@ If you choose not to use a lockfile, you must ensure that **caching is disabled*
To run without a lockfile:
1. Do not set the `cache` input.
2. If your `package.json` specifies a `packageManager` (which enables automatic caching in v5+), explicitly disable it:
2. If your `package.json` contains a ``packageManager` field set to npm (or devEngines.packageManager), automatic caching is enabled by default. Override this by setting package-manager-cache: false.
```yaml
steps: