Package Exports

github-release-notes
github-release-notes/src/gren.js
github-release-notes/src/utils

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

Node module that generates release notes based on commit messages or closed issues between tags. It also can create a full changelog or add the latest release notes to the existing changelog file.

If you want to include it in a task, you can use grunt-github-release-notes

Installation

Install github-release-notes via npm:

npm install github-release-notes -g

Setup

First generate a github token at this link. You only need "repo" scope. Then add this to ~/.bash_profile or ~/.zshrc):

export GREN_GITHUB_TOKEN=your_token_here

Basic Usage

# Navigate to your project directory
cd ~/Path/to/repo
# Run the task
gren

Otherwise, you can run it anywhere passing the repo information:

gren --username=[username] --repo=[repo name]

To use a specific token you can specify it as option:

gren --token=[your token]

Demo

gren demo

Actions

Gren has two main usages: release and changelog. You can select the action with the --action option.

See full documentation here