Skip to content

Commit 1a7dddb

Browse files
authored
Add ignoring label options (#36)
* Add ignoring label options * Update documentation for convertStringToArray() * Update docs
1 parent 26ad43e commit 1a7dddb

File tree

12 files changed

+670
-193
lines changed

12 files changed

+670
-193
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ Following the options for the module:
6161

6262
- `--action=release|changelog` The **gren** action to run. Default: `release` _(see details below for changelog generator)_
6363
- `--tags=0.1.0|0.2.0,0.1.0` A specific tag or the range of tags to build the release notes from.
64+
- `--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)_
65+
- `--ignore-issues-with=wont_fix|wont_fix,duplicate` Ignore issues that contains one of the specified issues. Default: `false`
6466
- `--time-wrap=latest|history` The release notes you want to include in the changelog. Default: `latest` _Only applicable to the `changelog` action_
6567
- `--changelog-filename=CHANGELOG.md` The name of the changelog file. Default: `CHANGELOG.md`
6668
- `--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*:
7981
{
8082
"action": "release",
8183
"timeWrap": "history",
82-
"dataSource": "commits"
84+
"dataSource": "commits",
85+
"ignoreIssuesWith": [
86+
"wontfix",
87+
"duplicate"
88+
]
8389
}
8490
```
8591

docs/GithubReleaseNotes.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<li class="dropdown">
4141
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
4242
<ul class="dropdown-menu ">
43-
<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>
43+
<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>
4444
</ul>
4545
</li>
4646

@@ -211,7 +211,7 @@ <h5>Parameters:</h5>
211211
<ul class="dummy">
212212
<li>
213213
<a href="gren.js.html">gren.js</a>,
214-
<a href="gren.js.html#sunlight-1-line-770">line 770</a>
214+
<a href="gren.js.html#sunlight-1-line-785">line 785</a>
215215
</li>
216216
</ul>
217217
</dd>
@@ -374,7 +374,7 @@ <h5>Parameters:</h5>
374374
<ul class="dummy">
375375
<li>
376376
<a href="gren.js.html">gren.js</a>,
377-
<a href="gren.js.html#sunlight-1-line-871">line 871</a>
377+
<a href="gren.js.html#sunlight-1-line-879">line 879</a>
378378
</li>
379379
</ul>
380380
</dd>
@@ -519,7 +519,7 @@ <h5>Parameters:</h5>
519519
<ul class="dummy">
520520
<li>
521521
<a href="gren.js.html">gren.js</a>,
522-
<a href="gren.js.html#sunlight-1-line-789">line 789</a>
522+
<a href="gren.js.html#sunlight-1-line-806">line 806</a>
523523
</li>
524524
</ul>
525525
</dd>
@@ -638,7 +638,7 @@ <h4 class="name" id="release"><span class="type-signature"></span>release()</h4>
638638
<ul class="dummy">
639639
<li>
640640
<a href="gren.js.html">gren.js</a>,
641-
<a href="gren.js.html#sunlight-1-line-823">line 823</a>
641+
<a href="gren.js.html#sunlight-1-line-839">line 839</a>
642642
</li>
643643
</ul>
644644
</dd>
@@ -741,7 +741,7 @@ <h4 class="modal-title">Search results</h4>
741741
<span class="jsdoc-message">
742742
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
743743

744-
on Wed Mar 8th 2017
744+
on Fri Mar 10th 2017
745745

746746
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
747747
</span>

docs/classes.list.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<li class="dropdown">
4141
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
4242
<ul class="dropdown-menu ">
43-
<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>
43+
<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>
4444
</ul>
4545
</li>
4646

@@ -206,7 +206,7 @@ <h4 class="modal-title">Search results</h4>
206206
<span class="jsdoc-message">
207207
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
208208

209-
on Wed Mar 8th 2017
209+
on Fri Mar 10th 2017
210210

211211
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
212212
</span>

docs/github-info.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<li class="dropdown">
4141
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
4242
<ul class="dropdown-menu ">
43-
<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>
43+
<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>
4444
</ul>
4545
</li>
4646

@@ -224,7 +224,7 @@ <h4 class="modal-title">Search results</h4>
224224
<span class="jsdoc-message">
225225
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
226226

227-
on Wed Mar 8th 2017
227+
on Fri Mar 10th 2017
228228

229229
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
230230
</span>

0 commit comments

Comments
 (0)