docs: Updated readme with the correct specification

rafinskipg · May 8, 2016 · ec2de4b · ec2de4b
1 parent 2f7021a
commit ec2de4b
Show file tree

Hide file tree

Showing 6 changed files with 407 additions and 53 deletions.
diff --git a/.changelog.rc → .changelogrc b/.changelog.rc → .changelogrc
@@ -1,7 +1,8 @@
-{
+    {
     "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. :)",
+    "debug": "true",
     "sections": [
         {
             "title": "Bug Fixes",

diff --git a/EXTENDEDCHANGELOG.md b/EXTENDEDCHANGELOG.md
@@ -1,10 +1,10 @@
 <img width="300px" src="https://github.com/rafinskipg/git-changelog/raw/master/images/git-changelog-logo.png" />
 
-__Git changelog extended__
+__Git Changelog__
 
 _Git changelog is a utility tool for generating changelogs. It is free and opensource. :)_
 
-#   (2015-06-05)
+#   (2016-05-08)
 
 
 
@@ -51,74 +51,176 @@ _Git changelog is a utility tool for generating changelogs. It is free and opens
   ([86eae3f0](https://github.com/rafinskipg/git-changelog/commit/86eae3f013ace1c5c23afc32b2e8f878a69629f1))
 
 
+## Documentation
+
+- Updated options and tagging info
+  ([1ad3b6be](https://github.com/rafinskipg/git-changelog/commit/1ad3b6bedc6431b70e3a2e93e5967bad9a7830ee))
+- added documentation for explaining the commit message
+  ([d516c2fb](https://github.com/rafinskipg/git-changelog/commit/d516c2fb464072fc1f4c86ec71a910eeab3e830c))
+- Added docs
+  ([e0ba50c0](https://github.com/rafinskipg/git-changelog/commit/e0ba50c0bb0b13e9b39a59b8f4dda96e86d55644))
+- **README:**
+  - Reorder contents
+  ([14e8a772](https://github.com/rafinskipg/git-changelog/commit/14e8a772c3a05c32bc9fba6f75565132025d4942))
+  - TOC
+  ([d6338ab4](https://github.com/rafinskipg/git-changelog/commit/d6338ab45f6e45e5562e5e6f4f1db86f39ca458d))
+  - Added more information on the new specification
+  ([f984eedd](https://github.com/rafinskipg/git-changelog/commit/f984eedde6be5db804d0b6bf2e238ab2e7ca15fb))
+  - added more commit examples and npm versioning usage
+  ([51341b7a](https://github.com/rafinskipg/git-changelog/commit/51341b7aae082c6c1a1caaa77dfdbfdc2622a56f))
+  - add logo
+  ([1af36c9b](https://github.com/rafinskipg/git-changelog/commit/1af36c9b0dad5cc0c2a321e3f280a89d76a8fb2b))
+- **readme:** Final readme Fixes #1 Closes #1
+  ([e725d8f4](https://github.com/rafinskipg/git-changelog/commit/e725d8f4bf477b517ca6185a75fdfa0aa660b3be),
+   [#1](https://github.com/rafinskipg/git-changelog/issues/1))
+
+
 ## Refactor
 
 - added debug messages and refactored some additional code
+  ([70e48caf](https://github.com/rafinskipg/git-changelog/commit/70e48caf330b7f76fdea474ce58bcf96cb11ccbc))
 - modified the task using a factory pattern to improve testability
+  ([1a0f25d3](https://github.com/rafinskipg/git-changelog/commit/1a0f25d3d9bbedd029c810c4dd2d35419cbb9276))
 - Removed ignore tags and updated documentation
+  ([cb17b55d](https://github.com/rafinskipg/git-changelog/commit/cb17b55de2ba0b597147fe4ce15e6883feb82a88))
 - removed deprecated options
+  ([7d05b632](https://github.com/rafinskipg/git-changelog/commit/7d05b632af6be3db2c00925b7cf28cd990c19a71))
 - **delete:** deleted some files
+  ([b9c72f57](https://github.com/rafinskipg/git-changelog/commit/b9c72f57c4920420fef8c486bfccf5798870e06b))
 - **docs:**
   - Angular document commits
+  ([01e8c1ba](https://github.com/rafinskipg/git-changelog/commit/01e8c1ba4c29fcddcfc237f4e6185682b9ced67d))
   - Added docs
+  ([0a155845](https://github.com/rafinskipg/git-changelog/commit/0a1558458c46574c5b0e6ec3749668fad1c8647a))
+- **generate:** replace `#getStream` with `fse#createOutputStream`
+  ([2d252d89](https://github.com/rafinskipg/git-changelog/commit/2d252d89017a70008896497e36f03e9d2add2c97))
 - **lib:** simplify methods and refactor into separate files
+  ([7a3600bf](https://github.com/rafinskipg/git-changelog/commit/7a3600bf9a5487cb26e3eb4b65ac774a68b6b91e))
 - **writeChangelog:** method now returns a promise
+  ([69fa1b0b](https://github.com/rafinskipg/git-changelog/commit/69fa1b0b11a603683342a9e0626cb69550b92002))
+
+
+## Style
+
+- **message:** Added a message on the changelog for referencing the github
+  ([d20031a9](https://github.com/rafinskipg/git-changelog/commit/d20031a9dc6fd92cba205903b2fd9d25feae6ea7))
+
+
+## Test
+
+- added test for .init(), .getPreviousTag(), getRepoUrl(), .log() and .warn()
+  ([fd099a85](https://github.com/rafinskipg/git-changelog/commit/fd099a858b44e67e28f4e18f07c520803f3ac55e))
+- removed unnecessary debug setting (was using for "debugging")
+  ([83cd52b1](https://github.com/rafinskipg/git-changelog/commit/83cd52b1e8b79dd6bff13dc0d2003e802f8e45e6))
+- updated test to cover promise return from .generate()
+  ([c182ee47](https://github.com/rafinskipg/git-changelog/commit/c182ee47a4ec36a453420f8cc04358ec6e98e381))
+- ensure changelog has default setting at the beginning of spec
+  ([31f81e26](https://github.com/rafinskipg/git-changelog/commit/31f81e262440aa10efafd90c74d98569df418795))
+- changed spy on changelog.generate() to stub, to avoid polluting following tests
+  ([0aa35588](https://github.com/rafinskipg/git-changelog/commit/0aa35588cf944b2f84b842d66220d50e8f5d96a8))
+- added test for .writeChageLog() and .organizeCommits()
+  ([b07f28e1](https://github.com/rafinskipg/git-changelog/commit/b07f28e1e92bdf20be669596651b344d2f70855e))
+- added default mocha options
+  ([595c8347](https://github.com/rafinskipg/git-changelog/commit/595c8347fd4e2b697ceac247babe7ece7c90c4fa))
+- added missing done() callback on .catch()
+  ([0da53e9c](https://github.com/rafinskipg/git-changelog/commit/0da53e9c8ad8a967753ac06dc1c23302c7956017))
+- added tests for tag option equals to false
+  ([1fc1e809](https://github.com/rafinskipg/git-changelog/commit/1fc1e809dcca7d499f870c314d2860121fcb6bab))
+- Added unit tests for commit parsing
+  ([504a61a7](https://github.com/rafinskipg/git-changelog/commit/504a61a715ed541feee4570810c2153ba8984420))
+- **writeChangelog:** updated test to reflect changes to method
+  ([b999948f](https://github.com/rafinskipg/git-changelog/commit/b999948f2c38f5d002fa0dc535429a80acdf2d75))
 
 
 ## Chore
 
 - a couple of spelling corrections [ci skip]
+  ([1486a845](https://github.com/rafinskipg/git-changelog/commit/1486a84537c5fd2d7997721820981c7949487af2))
 - minor edits to README
+  ([481c6c80](https://github.com/rafinskipg/git-changelog/commit/481c6c80d49e5e11c72d8378976d5d3ee1d581d2))
 - fixing lint errors
+  ([3a8e8d48](https://github.com/rafinskipg/git-changelog/commit/3a8e8d486a2b89b9f04d01200fe4f9f7851d0123))
 - added chai-as-promise to handle methods that return promises
+  ([1d384257](https://github.com/rafinskipg/git-changelog/commit/1d3842576839b763b28a777e96b061dbd4d01a80))
 - updated travis config
+  ([d6a7ef94](https://github.com/rafinskipg/git-changelog/commit/d6a7ef945f600ec787b515486bd3abfa2f86a25b))
 - stopped tracking test output files
+  ([1d12bccb](https://github.com/rafinskipg/git-changelog/commit/1d12bccb9f7dce07ff45318304dc5ab82620b6f1))
 - added istanbul configuration file
+  ([88c945e6](https://github.com/rafinskipg/git-changelog/commit/88c945e6d8ddddfe6ee3bdf808ae2c749b4eabf3))
 - updated travis configuration for code climate
+  ([fbd651dd](https://github.com/rafinskipg/git-changelog/commit/fbd651dd765a1ee26293dd03543e578181462e3f))
 - fixed lint issues in tests
+  ([2edb0199](https://github.com/rafinskipg/git-changelog/commit/2edb019910a421cd94868397a0f5881e90af4ed5))
 - add tests to lint task
+  ([1d789792](https://github.com/rafinskipg/git-changelog/commit/1d789792143d2f68820c16426e772857e45ba181))
 - add lint rules for mocha test
+  ([bbea9341](https://github.com/rafinskipg/git-changelog/commit/bbea9341acb37f729e7f83d59d784cb4ff7969e1))
 - ignore files generated by tests
+  ([3ccbff47](https://github.com/rafinskipg/git-changelog/commit/3ccbff47ee2dd655da95ea3a9b95cb156f8f6956))
 - update dependencies
+  ([3036d803](https://github.com/rafinskipg/git-changelog/commit/3036d8037f4af6aa34fb137037a9eb9d0ce34297))
 - removed unused dependency
+  ([cdd9f0d5](https://github.com/rafinskipg/git-changelog/commit/cdd9f0d5623f839eaaf646d4de0cf72816cf00af))
 - fixed typo
+  ([081a8f96](https://github.com/rafinskipg/git-changelog/commit/081a8f963104711b5f15bb8468489ee13927e226))
 - added commits fixture for tests
+  ([b7d16b68](https://github.com/rafinskipg/git-changelog/commit/b7d16b682a8167cd4a90e59c4f511774f6572ce1))
 - added missing development dependencies
+  ([e52e3ec6](https://github.com/rafinskipg/git-changelog/commit/e52e3ec6234db4cc9055c6e0abd5f32b587f67d6))
 - adding missing newline at the end of file
+  ([da4b5492](https://github.com/rafinskipg/git-changelog/commit/da4b54920e1be490fb47a25906eece63229b0094))
 - removed testing from grunt file (causing recursion issues during some tests)
+  ([8e94e8ac](https://github.com/rafinskipg/git-changelog/commit/8e94e8ac23e73709495cf0c6851fbaf1a84c0c9b))
 - install mocha before travis scripts
+  ([9be62aae](https://github.com/rafinskipg/git-changelog/commit/9be62aaeb7d50959cff870e0cabb08277d1c512b))
 - updated npm scripts and added debug
+  ([aa4f2a2d](https://github.com/rafinskipg/git-changelog/commit/aa4f2a2d7b834484f65239ceccdf4f973dbe0cee))
 - moved fixtures to the test folder
+  ([e59d429b](https://github.com/rafinskipg/git-changelog/commit/e59d429b032451f75ef986e2d1b3c63fb8672a1c))
 - removed unused test/hacky.js
+  ([500fdf3c](https://github.com/rafinskipg/git-changelog/commit/500fdf3c37e72c98f4809806e85926035eb46792))
 - rename changelog.spec.js to match file being tested
+  ([41757850](https://github.com/rafinskipg/git-changelog/commit/417578507b39aeffe826922ad3eccfcc13ad6ed0))
 - fixed lint errors
+  ([71a5eae2](https://github.com/rafinskipg/git-changelog/commit/71a5eae2212e7abf87c97a569f8251a56b5474a6))
 - added grunt coverage task
+  ([ef6cf2cf](https://github.com/rafinskipg/git-changelog/commit/ef6cf2cf14b69fe4200eb0eeb9319fb4bcdffcc2))
 - added node.js `0.12` to travis-ci config
+  ([24d9c58a](https://github.com/rafinskipg/git-changelog/commit/24d9c58a0a4ea349709719c431ca9878a2f01bc4))
 - Updated readme
+  ([fca6ecba](https://github.com/rafinskipg/git-changelog/commit/fca6ecbac686661ece15acdb41d23e86011457f2))
 - package json version 1.1.3
+  ([9d600386](https://github.com/rafinskipg/git-changelog/commit/9d6003868e352ae21383913f671bc091afc9d8c7))
+- **cleanup:**
+  - remove unnecessary code [skip ci]
+  ([80dbe3ec](https://github.com/rafinskipg/git-changelog/commit/80dbe3ec7a28e7c20d99e89009856c70138350b0))
+  - remove `#getStream` and `#checkPath`
+  ([cd75ebc4](https://github.com/rafinskipg/git-changelog/commit/cd75ebc44e39242b7e9c8ef2363c86d3f1cabc0e))
+- **deps:** install fs-extra@0.18.4
+  ([7c8e257b](https://github.com/rafinskipg/git-changelog/commit/7c8e257b81f0daeba7e347d175583af1a7a9bfa0))
 - **images:**
   - add logo in JPEG format
+  ([50338b9a](https://github.com/rafinskipg/git-changelog/commit/50338b9a8b5540e42273857448e803d8b85c689d))
   - add logo in PNG format
+  ([bb5fbbdb](https://github.com/rafinskipg/git-changelog/commit/bb5fbbdba7ef2b9466c185c12ef426d82fe25bcf))
 - **lint:**
   - add missing semicolon
+  ([2888af48](https://github.com/rafinskipg/git-changelog/commit/2888af4803f85da1afbb8c9832314f53cc4ca131))
   - fix indentation
+  ([4cf9b6e6](https://github.com/rafinskipg/git-changelog/commit/4cf9b6e69a1426d48f18da45614f8f01994707b7))
   - have jshint ignore false positives
+  ([ed8e9df4](https://github.com/rafinskipg/git-changelog/commit/ed8e9df48720c42086186fa4219262a351bbc3e4))
   - fixing jshint errors
+  ([987366f0](https://github.com/rafinskipg/git-changelog/commit/987366f02517c9cfdb62264d0f6ea7d0b20d6634))
 - **package:** Package json version
+  ([990b8ea0](https://github.com/rafinskipg/git-changelog/commit/990b8ea04ca04f3c907653b0fa89ae6ddd601092))
 - **package.json:** Added preversion script
+  ([b3f1e44a](https://github.com/rafinskipg/git-changelog/commit/b3f1e44a900b00bda1facaee5354ba1ff58166aa))
 - **release:** 0.1.8 codename(furious-stallman)
+  ([b9432318](https://github.com/rafinskipg/git-changelog/commit/b943231854ffd6cb0c5f32e5482cadd99c96f3e9))
 - **task:** cleanup unused requires
-
-
-## Documentation
-
-- Updated options and tagging info
-- added documentation for explaining the commit message
-- Added docs
-- **README:**
-  - added more commit examples and npm versioning usage
-  - add logo
-- **readme:** Final readme Fixes #1 Closes #1
+  ([8a41d4e7](https://github.com/rafinskipg/git-changelog/commit/8a41d4e7b245b2698749279765bcef4748e18ac7))
 
 
 

diff --git a/Gruntfile.js b/Gruntfile.js
@@ -59,7 +59,48 @@ module.exports = function(grunt) {
           tag: false,
           debug: true,
           file : 'EXTENDEDCHANGELOG.md',
-          grep_commits: '^fix|^feat|^docs|^refactor|^chore|BREAKING'
+          sections: [
+            {
+                "title": "Bug Fixes",
+                "grep": "^fix"
+            },
+            {
+                "title": "Features",
+                "grep": "^feat"
+            },
+            {
+                "title": "Documentation",
+                "grep": "^docs"
+            },
+            {
+                "title": "Breaking changes",
+                "grep": "BREAKING"
+            },
+            {
+                "title": "Refactor",
+                "grep": "^refactor"
+            },
+            {
+                "title": "Style",
+                "grep": "^style"
+            },
+            {
+                "title": "Test",
+                "grep": "^test"
+            },
+            {
+                "title": "Chore",
+                "grep": "^chore"
+            },
+            {
+                "title": "Branchs merged",
+                "grep": "^Merge branch"
+            },
+            {
+                "title" : "Pull requests merged",
+                "grep": "^Merge pull request"
+            }
+          ]
         }
       }
     },