Add ignoring label options (#36)

* Add ignoring label options * Update documentation for convertStringToArray() * Update docs
github-tools · Mar 10, 2017 · 1a7dddb · 1a7dddb
1 parent 26ad43e
commit 1a7dddb
Show file tree

Hide file tree

Showing 12 changed files with 670 additions and 193 deletions.
diff --git a/README.md b/README.md
@@ -61,6 +61,8 @@ Following the options for the module:
 
 - `--action=release|changelog` The **gren** action to run. Default: `release` _(see details below for changelog generator)_
 - `--tags=0.1.0|0.2.0,0.1.0` A specific tag or the range of tags to build the release notes from.
+- `--ignore-labels=wont_fix|wont_fix,duplicate` One or more labels to ignore in the output. Default: `false` _(it will still output the issue, just without the specified labels)_
+- `--ignore-issues-with=wont_fix|wont_fix,duplicate` Ignore issues that contains one of the specified issues. Default: `false`
 - `--time-wrap=latest|history` The release notes you want to include in the changelog. Default: `latest` _Only applicable to the `changelog` action_
 - `--changelog-filename=CHANGELOG.md` The name of the changelog file. Default: `CHANGELOG.md`
 - `--data-source=issues|commits` The informations you want to use to build release notes. Default: `issues`
@@ -79,7 +81,11 @@ The options in the file would be camelCase *e.g*:
 {
     "action": "release",
     "timeWrap": "history",
-    "dataSource": "commits"
+    "dataSource": "commits",
+    "ignoreIssuesWith": [
+        "wontfix",
+        "duplicate"
+    ]
 }
 ```
 

diff --git a/docs/GithubReleaseNotes.html b/docs/GithubReleaseNotes.html
@@ -40,7 +40,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#dashToCamelCase">dashToCamelCase</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#getBashOptions">getBashOptions</a></li><li><a href="global.html#isInRange">isInRange</a></li><li><a href="global.html#printTask">printTask</a></li><li><a href="global.html#repo">repo</a></li><li><a href="global.html#task">task</a></li><li><a href="global.html#token">token</a></li><li><a href="global.html#user">user</a></li>
+					<li><a href="global.html#clearTasks">clearTasks</a></li><li><a href="global.html#convertStringToArray">convertStringToArray</a></li><li><a href="global.html#dashToCamelCase">dashToCamelCase</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#getBashOptions">getBashOptions</a></li><li><a href="global.html#isInRange">isInRange</a></li><li><a href="global.html#printTask">printTask</a></li><li><a href="global.html#repo">repo</a></li><li><a href="global.html#task">task</a></li><li><a href="global.html#token">token</a></li><li><a href="global.html#user">user</a></li>
 				</ul>
 			</li>
 
@@ -211,7 +211,7 @@ <h5>Parameters:</h5>
 		<ul class="dummy">
 			<li>
 				<a href="gren.js.html">gren.js</a>,
-				 <a href="gren.js.html#sunlight-1-line-770">line 770</a>
+				 <a href="gren.js.html#sunlight-1-line-785">line 785</a>
 			</li>
 		</ul>
 	</dd>
@@ -374,7 +374,7 @@ <h5>Parameters:</h5>
 		<ul class="dummy">
 			<li>
 				<a href="gren.js.html">gren.js</a>,
-				 <a href="gren.js.html#sunlight-1-line-871">line 871</a>
+				 <a href="gren.js.html#sunlight-1-line-879">line 879</a>
 			</li>
 		</ul>
 	</dd>
@@ -519,7 +519,7 @@ <h5>Parameters:</h5>
 		<ul class="dummy">
 			<li>
 				<a href="gren.js.html">gren.js</a>,
-				 <a href="gren.js.html#sunlight-1-line-789">line 789</a>
+				 <a href="gren.js.html#sunlight-1-line-806">line 806</a>
 			</li>
 		</ul>
 	</dd>
@@ -638,7 +638,7 @@ <h4 class="name" id="release"><span class="type-signature"></span>release()</h4>
 		<ul class="dummy">
 			<li>
 				<a href="gren.js.html">gren.js</a>,
-				 <a href="gren.js.html#sunlight-1-line-823">line 823</a>
+				 <a href="gren.js.html#sunlight-1-line-839">line 839</a>
 			</li>
 		</ul>
 	</dd>
@@ -741,7 +741,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on Wed Mar 8th 2017
+		on Fri Mar 10th 2017
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/classes.list.html b/docs/classes.list.html
@@ -40,7 +40,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#dashToCamelCase">dashToCamelCase</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#getBashOptions">getBashOptions</a></li><li><a href="global.html#isInRange">isInRange</a></li><li><a href="global.html#printTask">printTask</a></li><li><a href="global.html#repo">repo</a></li><li><a href="global.html#task">task</a></li><li><a href="global.html#token">token</a></li><li><a href="global.html#user">user</a></li>
+					<li><a href="global.html#clearTasks">clearTasks</a></li><li><a href="global.html#convertStringToArray">convertStringToArray</a></li><li><a href="global.html#dashToCamelCase">dashToCamelCase</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#getBashOptions">getBashOptions</a></li><li><a href="global.html#isInRange">isInRange</a></li><li><a href="global.html#printTask">printTask</a></li><li><a href="global.html#repo">repo</a></li><li><a href="global.html#task">task</a></li><li><a href="global.html#token">token</a></li><li><a href="global.html#user">user</a></li>
 				</ul>
 			</li>
 
@@ -206,7 +206,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on Wed Mar 8th 2017
+		on Fri Mar 10th 2017
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/github-info.js.html b/docs/github-info.js.html
@@ -40,7 +40,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#dashToCamelCase">dashToCamelCase</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#getBashOptions">getBashOptions</a></li><li><a href="global.html#isInRange">isInRange</a></li><li><a href="global.html#printTask">printTask</a></li><li><a href="global.html#repo">repo</a></li><li><a href="global.html#task">task</a></li><li><a href="global.html#token">token</a></li><li><a href="global.html#user">user</a></li>
+					<li><a href="global.html#clearTasks">clearTasks</a></li><li><a href="global.html#convertStringToArray">convertStringToArray</a></li><li><a href="global.html#dashToCamelCase">dashToCamelCase</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#getBashOptions">getBashOptions</a></li><li><a href="global.html#isInRange">isInRange</a></li><li><a href="global.html#printTask">printTask</a></li><li><a href="global.html#repo">repo</a></li><li><a href="global.html#task">task</a></li><li><a href="global.html#token">token</a></li><li><a href="global.html#user">user</a></li>
 				</ul>
 			</li>
 
@@ -224,7 +224,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on Wed Mar 8th 2017
+		on Fri Mar 10th 2017
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>