Skip to content
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

nlf/docs updates #4961

Merged
merged 2 commits into from
Jun 1, 2022
Merged

nlf/docs updates #4961

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5edbd26
docs: add `npm version` notes to scripts doc
nlf May 31, 2022
f444a27
docs: clarify when git deps will be cloned and installed before packing
nlf May 31, 2022
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
Prev Previous commit
docs: clarify when git deps will be cloned and installed before packing
  • Loading branch information
@nlf
nlf committed May 31, 2022
commit f444a27e6186835a1abbc8f94734ed514449b626
20 changes: 20 additions & 0 deletions docs/content/configuring-npm/package-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,6 +643,26 @@ git+https://isaacs@github.com/npm/cli.git
git://github.com/npm/cli.git#v1.0.27
```

When installing from a `git` repository, the presence of certain fields in the
`package.json` will cause npm to believe it needs to perform a build. To do so
your repository will be cloned into a temporary directory, all of its deps
installed, relevant scripts run, and the resulting directory packed and
installed.

This flow will occur if your git dependency uses `workspaces`, or if any of the
following scripts are present:

* `build`
* `prepare`
* `prepack`
* `preinstall`
* `install`
* `postinstall`

If your git repository includes pre-built artifacts, you will likely want to
make sure that none of the above scripts are defined, or your dependency
will be rebuilt for every installation.

#### GitHub URLs

As of version 1.1.65, you can refer to GitHub urls as just "foo":
Expand Down