This addon provides a template for helping you keep an updated changelog for your ember-cli project or addon.
This addon integrates with ember-cli-release by giving you the opportunity to generate changelog updates and manually edit them if needed before ember-cli-release completes the release commit.
This addon parses your commit messages in order to be able to format them better in your changelog.
By default, it assumes you are using angular-style commit messages, but ember
and jquery
style
are also supported.
Set the style
property to ember
angular
or jquery
to specify your preference, or implement
hooks.parser
to parse the commits in a custom manner. (Guidelines on what a parsed commit will
need to expose coming soon).
Nearly every step of the changelog generation process is hookable via config/changelog.js
.
If you want to use github private repos set your github token with the following environment variable
GITHUB_TOKEN=123abc
- Open an Issue for discussion first if you're unsure a feature/fix is wanted.
- Branch off of
master
- Use descriptive branch names
- Use Angular-Style Commits
- PR against
master
.