Giter Site home page Giter Site logo

github-release-notes's Introduction

github-release-notes

npm version

Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last tag and the latest release.

Installation

The plugin requires Node ^0.12., since is using Promises.

Install github-release-notes via npm:

npm install github-release-notes --save-dev

Usage

You can run the command via the terminal (the three arguments are all required):

node github-release-notes --token=[token] --username=[username] --repo=[repo name]

To generate a github token, follow this link;

Optionals

There are optional arguments such as:

  • --draft=true To set the release as a draft. Default: false
  • --prerelease=true To set the release as a prerelease. Default: false
  • --prefix=v Add a prefix to the tag version e.g. v1.0.1

github-release-notes's People

Contributors

alexcanessa avatar

Watchers

James Cloos avatar Arvin Bhurtun 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.