documentation icon indicating copy to clipboard operation
documentation copied to clipboard

feat(install): add instructions for git packages

Open avivkeller opened this issue 9 months ago • 2 comments

This PR adds instructions to documentation regarding the installation of packages from git repositories.

References

Ref: https://github.com/nodejs/api-docs-tooling/issues/236#issuecomment-2752987110

avivkeller avatar Mar 26 '25 13:03 avivkeller

Can't wait 🤞

kenshanta avatar May 25 '25 16:05 kenshanta

If we're gonna advertise this more heavily we'll want to link to or reiterate some of the many quirks of installing from source control. A good example recently is this issue where some folks didn't know that because git source control and not published assets there are scripts that always run.

We don't really recommend using git urls, such as it is. It's only sometimes helpful in local development and never a good idea for a published module. Git urls are not idempotent, and the assumption of many of them is that they are source code that needs to be built.

wraithgar avatar May 27 '25 16:05 wraithgar