git-changelog
Advanced tools
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 JohnnyStilles 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:
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-dev
Once 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'
}
},
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'
}
}
}
})
git config --get remote.origin.url ,CHANGELOG.md,My App - Changelog'^fix|^feat|^docs|^refactor|^chore|BREAKING'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]
-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 message
git commit -m "docs: added documentation for explaining the commit message"
Must be one of the following:
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:
###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 lieu of a formal styleguide, 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)
FAQs
A git changelog tool
The npm package git-changelog receives a total of 373 weekly downloads. As such, git-changelog popularity was classified as not popular.
We found that git-changelog demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.