Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    github-autochangelogpublic

    Automatically generate changelogs using the GitHub API, for Node.JS

    changelog auto generation based on github issues + git version tag deltas

    Installation

    Install with the Node.JS package manager npm:

      $ npm install -g github-autochangelog
    

    or

    Install via git clone:

      $ git clone git@github.com:kaosat-dev/node-github-autochangelog.git
      $ cd node-github-autochangelog
      $ npm install -g
    

    Example

    command line usage :

    ghchangelog --repo https://github.com/kaosat-dev/DummyRepo --out mychangeLog.md -v 2
    

    output :

    DummyRepo: v0.1.0

    • Done: issue 1

    DummyRepo: v0.2.0

    • Done: issue 1
    • Fixed: issue 2
    • Done: issue 3

    DummyRepo: v0.3.0

    • Done: issue 3
    • Done: issue 5

    Notes

    • favor using commits to close github issues
    • tag correctly after closing issues

    Licence

    MIT

    Keywords

    none

    install

    npm i github-autochangelog

    Downloadsweekly downloads

    2

    version

    0.0.3

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar