github-release-notes - npm Package Compare versions

Comparing version 0.8.1 to 0.9.0

CHANGELOG.md

 # Changelog
 
 ## v0.8.1 (13/04/2017)
-*No changelog for this release.*
 
+#### Bug Fixes:
+
+- [#70](https://github.com/github-tools/github-release-notes/issues/70) Options don't get converted to camelCase from bash
+
 ---
@@ -7,0 +10,0 @@

package.json

 {
   "name": "github-release-notes",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Node module to publish release notes based on commits between the last two tags.",
@@ -5,0 +5,0 @@ "main": "./github-release-notes.js",

src/gren.js

@@ -17,5 +17,6 @@ 'use strict';
     tags: false,
-    timeWrap: 'latest', // || history
     changelogFilename: 'CHANGELOG.md',
     dataSource: 'issues', // || commits
+    onlyMilestones: false,
+    milestoneMatch: 'Release {{tag_name}}',
     draft: false,
@@ -513,2 +514,18 @@ force: false,
 /**
+ * Filter the issue based on gren options and labels
+ *
+ * @since 0.9.0
+ * @private
+ *
+ * @param  {GithubReleaseNotes} gren
+ * @param  {Object} issue
+ *
+ * @return {Boolean}
+ */
+function filterIssue(gren, issue) {
+    return !issue.pull_request && compareIssueLabels(gren.options.ignoreIssuesWith, issue.labels) &&
+        !((gren.options.onlyMilestones || gren.options.dataSource === 'milestones') && !issue.milestone);
+}
+
+/**
  * Get all the closed issues from the current repo
@@ -534,5 +551,3 @@ *
 
-        var filteredIssues = response.data.filter(function(issue) {
-            return !issue.pull_request && compareIssueLabels(gren.options.ignoreIssuesWith, issue.labels);
-        });
+        var filteredIssues = response.data.filter(filterIssue.bind(null, gren));
 
@@ -630,2 +645,27 @@ process.stdout.write(filteredIssues.length + ' issues found\n');
 /**
+ * Filter the issue based on the date range, or if is in the release
+ * milestone.
+ *
+ * @since 0.9.0
+ * @private
+ *
+ * @param  {GithubReleaseNotes} gren
+ * @param  {Array} range The release ranges
+ * @param  {Object} issue GitHub issue
+ *
+ * @return {Boolean}
+ */
+function filterBlockIssue(gren, range, issue) {
+    if (gren.options.dataSource === 'milestones') {
+        return gren.options.milestoneMatch.replace('{{tag_name}}', range[0].name) === issue.milestone.title;
+    }
+
+    return utils.isInRange(
+        Date.parse(issue.closed_at),
+        Date.parse(range[1].date),
+        Date.parse(range[0].date)
+    );
+}
+
+/**
  * Get the blocks of issues based on release dates
@@ -648,10 +688,3 @@ *
                 .map(function(range) {
-                    var filteredIssues = issues.filter(function(issue) {
-                        return utils.isInRange(
-                            Date.parse(issue.closed_at),
-                            Date.parse(range[1].date),
-                            Date.parse(range[0].date)
-                        );
-                    });
-
+                    var filteredIssues = issues.filter(filterBlockIssue.bind(null, gren, range));
                     var body = (!range[0].body || gren.options.override) && groupBy(gren, filteredIssues);
@@ -702,3 +735,3 @@
 
-    if (sortedReleaseDates.length === 1 || gren.options.timeWrap === 'history') {
+    if (sortedReleaseDates.length === 1) {
         sortedReleaseDates.push({
@@ -729,3 +762,4 @@ id: 0,
         issues: getIssueBlocks,
-        commits: getCommitBlocks
+        commits: getCommitBlocks,
+        milestones: getIssueBlocks
     };
@@ -839,3 +873,2 @@
     this.issues = null;
-    this.isEditingLatestRelease = false;
 }
@@ -872,3 +905,3 @@
                 token: gren.options.token
-            });
+            }, gren.options.apiUrl);
 
@@ -875,0 +908,0 @@ gren.repo = githubApi.getRepo(gren.options.username, gren.options.repo);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43145

increased by1.96%

Lines of code

1229

increased by2.59%

No dependency changes