Fork 0
Use Git as an npm registry https://conduitry.dev/npm2git
Go to file
Conduitry af0f8c2da8 add option to control branching and tagging 2018-12-11 10:27:00 -05:00
LICENSE add license 2018-10-03 23:08:23 -04:00
README.md adjust readme 2018-11-11 11:21:10 -05:00
npm2git.sh add option to control branching and tagging 2018-12-11 10:27:00 -05:00



Use Git as an npm registry


Managing npm registries sucks. (And arguably, depending on a central privately-controlled npm registry also sucks.) If you're thinking you want or need to run one, then it's very likely you already have a Git server available with all the appropriate users and permissions and everything. npm (since version 5) supports resolving semver ranges against Git tags, so there's no longer a good reason not to abuse Git to deliver built assets.


This shell script creates and tags an orphaned commit which includes only the files that would be included by npm publish. Before doing so, it also removes the prepare script from package.json, if present. (When npm installs from a Git repository with a prepare script, it will also temporarily install devDependencies and run the prepare script, which generally would build the project. Here, what npm's getting is already the built files, so we don't want that to happen.) It also creates a (non-annotated) vX.X.X-src tag which points to the original source that the (annotated) vX.X.X tag was built from.


  1. Make sure you're ready to go: Your project should be built, the version field in your package.json should already be incremented, and the files field should point to everything you want to publish.
  2. Run npm2git.sh. This creates the orphaned commit and the tags, but does not push anything.
  3. Inspect the tags to make sure all seems well, and then push.

Installing from Git

See the npm docs on npm install for more on how to install from Git repositories. Specify a version either by tag (#vX.X.X) or by semver specification (#semver:*).


Copyright (c) 2018 Conduitry