refactor: Removed ignore tags and updated documentation

rafinskipg · Apr 18, 2015 · cb17b55 · cb17b55
1 parent 7d05b63
commit cb17b55
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 8 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -32,7 +32,7 @@ module.exports = function(grunt) {
  git_changelog: {
  minimal: {
  options: {
- appName : 'Git changelog'
+ app_name : 'Git changelog'
  }
  },
  tag1: {
@@ -46,8 +46,8 @@ module.exports = function(grunt) {
  extended: {
  options: {
  repo_url: 'https:/rafinskipg/git-changelog',
- appName : 'Git changelog extended',
- ignore_tags: true,
+ app_name : 'Git changelog extended',
+ tag: false,
  file : 'EXTENDEDCHANGELOG.md',
  grep_commits: '^fix|^feat|^docs|^refactor|^chore|BREAKING'
  }

diff --git a/README.md b/README.md
@@ -38,16 +38,25 @@ grunt.initConfig({
  git_changelog: {
  minimal: {
  options: {
- file: 'https:/rafinskipg/git-changelog',
- appName : 'Git changelog'
+ file: 'MyChangelog.md',
+ app_name : 'Git changelog'
  }
  },
  extended: {
  options: {
  repo_url: 'https:/rafinskipg/git-changelog',
- appName : 'Git changelog extended',
+ app_name : 'Git changelog extended',
  file : 'EXTENDEDCHANGELOG.md',
- grep_commits: '^fix|^feat|^docs|^refactor|^chore|BREAKING'
+ grep_commits: '^fix|^feat|^docs|^refactor|^chore|BREAKING',
+ tag : false //False for commits since the beggining
+ }
+ },
+ fromCertainTag: {
+ options: {
+ repo_url: 'https:/rafinskipg/git-changelog',
+ app_name : 'My project name',
+ file : 'tags/certainTag.md',
+ tag : 'v0.0.1'
  }
  }
  }

diff --git a/tasks/git_changelog_generate.js b/tasks/git_changelog_generate.js
@@ -307,7 +307,7 @@ var generate = function(params) {
  .then(function(tag) {
  var fn ;
 
- if(typeof(tag) !== 'undefined' && tag !== false && !OPTS.ignore_tags){
+ if(typeof(tag) !== 'undefined' && tag !== false){
  log('Reading git log since', tag);
  OPTS.msg += 'since tag: '+ tag +';';
  fn = function(){ return readGitLog(GIT_LOG_CMD, tag);};