Git Product home page Git Product logo

js-changelog's Introduction

@cionzo/js-changelog 1.3.1

Semantic versioning and changelog generation utils

Installation

This is a Node.js module available through the github repository.

It can be installed using the npm or yarn command line tools.

npm install git+https://github.com/cionz0/js-changelog --save-dev

Usage

Configuration

Add the target js-changelog to the scripts section of your package.json file.

{
    // ...
    "scripts": {
        // ...
        "js-changelog": "npx @cionzo/js-changelog"
    }
}

Remember that, in order to pass arguments to a node-invoked target, you should use --.

node js-changelog -- --help

Example

In order to correctly use this tool, your changes must be already committed and pushed. Your local and remote repositories are hence assumed to refer to the same commit.

At this point, you can run something like the following command.

node js-changelog -- --minor

Tests

npm install
npm test

Dependencies

  • argparse: CLI arguments parser. Native port of python's argparse.
  • auto-changelog: Command line tool for generating a changelog from git tags and commit history
  • prompt-sync: a synchronous prompt for node.js

License

GPL-3.0

js-changelog's People

Contributors

cionz0 avatar

Watchers

 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.