JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10021
  • Score
    100M100P100Q128133F
  • License ISC

Node module to publish release notes based on commits between the last two tags.

Package Exports

  • github-release-notes
  • github-release-notes/src/index.js

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 (github-release-notes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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
  • --include-messages=merges/commits/all used to filter the messages added to the release notes. Default: commits