A git changelog based on ANGULAR JS commit standards. NPM page
Works as a CLI option or grunt plugin
version 0.1.7 is out, special thanks to JohnnyEstilles for his work.
This release includes a big refactor with a huge improvement on test coverage.
Git changelog is secure enough
Next releases will include:
- Downloadable resources area on the generated changelog, for linking to your zip project folder of certain tag.
- .gitchangelogrc specification. That will allow using any comment standards for your commit messages.
This plugin requires Grunt ~0.4.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install git-changelog --save-devOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('git-changelog');In your project's Gruntfile, add a section named git_changelog to the data object passed into grunt.initConfig().
grunt.initConfig({
git_changelog: {
minimal: {
options: {
file: 'MyChangelog.md',
app_name : 'Git changelog',
logo : 'https://github.com/rafinskipg/git-changelog/raw/master/images/git-changelog-logo.png',
intro : 'Git changelog is a utility tool for generating changelogs. It is free and opensource. :)'
}
},
extended: {
options: {
repo_url: 'https://github.com/rafinskipg/git-changelog',
app_name : 'Git changelog extended',
file : 'EXTENDEDCHANGELOG.md',
grep_commits: '^fix|^feat|^docs|^refactor|^chore|BREAKING',
debug: true,
tag : false //False for commits since the beggining
}
},
fromCertainTag: {
options: {
repo_url: 'https://github.com/rafinskipg/git-changelog',
app_name : 'My project name',
file : 'tags/certainTag.md',
tag : 'v0.0.1'
}
}
}
})- branch_name : The name of the branch. Defaults to
- repo_url : The url of the project. For issues and commits links. Defaults to
git config --get remote.origin.url - version: The version of the project. Defaults to
- file: The name of the file that will be generated. Defaults to
CHANGELOG.md, - app_name : The name of the project. Defaults to
My App - Changelog - intro : The introduction text on the header of the changelog. Defaults to
null - logo : A logo URL to be included in the header of the changelog. Defaults to
null - grep_commits: The commits that will be picked. Defaults to
'^fix|^feat|^docs|^refactor|^chore|BREAKING' - tag: You can select from which tag to generate the log, it defaults to the last one. Set it to false for log since the beginning of the project
- debug: Debug mode, false by default
Install it globally
npm install -g git-changelog
See commands
git-changelog -h
Use it directly with the common options
Usage: git-changelog [options]
Options:
-h, --help output usage information
-V, --version output the version number
-e, --extended Extended log
-a, --app_name [app_name] Name [app_name]
-b, --branch [branch_name] Branch name [branch_name]
-f, --file [file] File [file]
-r, --repo_url [url] Repo url [url]
-l, --logo [logo] Logo path [logo]
-i, --intro [intro] intro text [intro]
-t, --tag [tag] Since tag [tag]
-g, --grep [grep] Grep commits for [grep]
-d, --debug Debugger
For example:
git-changelog -t false -a "My nice application"
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the AngularJS change log.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools.
Example commit messages
git commit -m "docs(readme): added documentation for explaining the commit message"
git commit -m "refactor: Changed other things"
Closing issues :
git commit -m "fix(git_changelog_generate): pass tag if it exists to gitReadLog
Previously if a tag was found the script would try to find commits
between undefined..HEAD. By passing the tag, it now finds tags between
tag..HEAD.
Closes #5."
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
The scope could be anything specifying place of the commit change. For example $location,
$browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
###Body Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes" The body should include the motivation for the change and contrast this with previous behavior.
###Footer The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
A detailed explanation can be found in this [document][commit-message-format]. [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
In order to have you project versions correctly displayed on your changelog, try to use this commit message format:
chore(release): v1.4.0 codename(jaracimrman-existence)
In order to do that, you can use git annotated tags:
git tag -a v1.4.0 -m 'chore(release): v1.4.0 codename(jaracimrman-existence)'
If you are publishing NPM modules you can let NPM do that for you:
npm version patch -m "chore(release): %s codename(furious-stallman)"
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
(Nothing yet)