JSPM

npm-auto-version

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2234
  • Score
    100M100P100Q91505F
  • License BSD-3-Clause

Automatically generates version number based on Git Tags

Package Exports

  • npm-auto-version

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (npm-auto-version) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NPM Auto Version

npm downloads

This script is used to automatically generate new NPM versions based on Git tags when publishing.

Usage

Recommended contents of your package.json:

{
    "version": "1.0.0",
    "scripts": {
        "prepublish": "npm-auto-version",
        "postpublish": "git push origin --tags"
    }
}

This will (under the hood) do the following when you run npm publish:

  • Get the MAJOR.MINOR version from your package.json version field (call them M and N respectively)
  • Get the list of git tags that match M.N.*
  • Use semver to generate the next appropriate patch value M.N.P
  • Update the package.json version field with M.N.P
  • Generate a new git tag in the NPM syntax: vM.N.P
  • Publish the package to NPM (via npm publish)
  • Push the tags to your git origin

Requirements

This script requires:

  • Node 0.12+
  • Git client and grep installed in $PATH
  • Shell that supports pipe |

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.