Publish a release note by commits between tags.
Switch branches/tags
Nothing to show
Clone or download
Latest commit e3643d4 Aug 20, 2017

README.md

tui-release-notes

Gather commits on tag

Installation

// package.json
devDependencies: {
    "tui-release-notes": "git+https://github.com/nhnent/tui.release-notes.git"
}

Before Use

  1. Check package.json has repository property
// package.json
"repository": {
  "type": "git",
  "url": "https://github.com/username/repository-name.git"
}
// or for short expression
"repository": "https://github.com/username/repository-name.git"
  1. Register TUI_GITHUB_TOKEN as a environment variables

  2. Execute tuie on your project root

// package.json
scripts: {
    "tuie": "tuie"
}

Usage

# latest tag
npm run tuie
# specific tag
npm run tuie --tag={specific-tag}
# enterprise
npm run tuie --apiUrl={github.your-enterprise-url.com/api/v3}

License

This software is licensed under the MIT License.