Skip to content

docs: clarify release age behavior for npm ci #9844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lreading-turnkey wants to merge 1 commit into
base: latest
Choose a base branch
from
+11 −0
Open

docs: clarify release age behavior for npm ci #9844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/lib/content/commands/npm-ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ The main differences between using `npm install` and `npm ci` are:
* If a `node_modules` is already present, it will be automatically removed before `npm ci` begins its install.
* It will never write to `package.json` or `package-lock.json`:
installs are essentially frozen.
* `--before` and `--min-release-age` do not affect `npm ci`, which installs
the versions recorded in the lockfile without resolving versions or checking
release dates.

NOTE: If you create your `package-lock.json` file by running `npm install` with flags that can affect the shape of your dependency tree, such as
`--legacy-peer-deps` or `--install-links`, you _must_ provide the same flags to `npm ci` or you are likely to encounter errors.
Expand Down
8 changes: 8 additions & 0 deletions workspaces/config/lib/definitions/definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,10 @@ const definitions = {

Packages whose names match \`min-release-age-exclude\` are exempt from
this filter.

NOTE: \`npm ci\` does not apply this setting. It installs the versions
recorded in the lockfile without resolving versions or checking release
dates.
`,
flatten,
}),
Expand Down Expand Up @@ -1563,6 +1567,10 @@ const definitions = {

Packages whose names match \`min-release-age-exclude\` are exempt from
this filter.

NOTE: \`npm ci\` does not apply this setting. It installs the versions
recorded in the lockfile without resolving versions or checking release
dates.
`,
flatten: (key, obj, flatOptions) => {
const age = obj['min-release-age']
Expand Down