GithubHelp home page GithubHelp logo

orgordin / npm-auto-version Goto Github PK

View Code? Open in Web Editor NEW

This project forked from yahoo/npm-auto-version

0.0 0.0 0.0 5 KB

Automatically generate new NPM versions based on Git tags when publishing

Home Page: https://www.npmjs.com/package/npm-auto-version

License: Other

JavaScript 100.00%

npm-auto-version's Introduction

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.

npm-auto-version's People

Contributors

stjohnjohnson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.