github-changes - npm Package Compare versions

Comparing version 1.0.4 to 1.1.0

bin/index.js

@@ -396,2 +396,13 @@ #!/usr/bin/env node
     var isPull = isMerge && /^Merge pull request #/i.test(commit.commit.message);
+    var isSquashAndMerge = false;
+
+    // handle checking for a squash & merge
+    if (!isPull) {
+      isPull = /\s\(\#\d+\)/i.test(commit.commit.message); //contains ' (#123)'?
+      if (isPull) {
+        isMerge = true;
+        isSquashAndMerge = true;
+      }
+    }
+
     // exits
@@ -406,3 +417,3 @@ if ((opts.merges === false) && isMerge) return '';
 
-    if (opts['use-commit-body'] && commit.parents.length > 1) {
+    if (!isSquashAndMerge && opts['use-commit-body'] && commit.parents.length > 1) {
       message = messages.join(' ').trim() || message;
@@ -445,4 +456,15 @@ }
     if (isPull) {
-      var prNumber = commit.commit.message.split('#')[1].split(' ')[0];
-      var author = (commit.commit.message.split(/\#\d+\sfrom\s/)[1]||'').split('/')[0];
+      var prNumber = null;
+      var author = null;
+      var authorName = commit.commit.author && commit.commit.author.name;
+
+      if (isSquashAndMerge) {
+        prNumber = commit.commit.message.match(/\(#\d+\)/)[0].replace(/\(|\)|#/g,'');
+        author = (commit.author && commit.author.login);
+      } else {
+        prNumber = commit.commit.message.split('#')[1].split(' ')[0];
+        author = (commit.commit.message.split(/\#\d+\sfrom\s/)[1]||'').split('/')[0];
+      }
+
+
       var host = (opts.host === 'api.github.com') ? 'github.com' : opts.host;
@@ -452,6 +474,10 @@ var url = "https://"+host+"/"+opts.owner+"/"+opts.repository+"/pull/"+prNumber;
 
-      if (authors.length)
+      if (authors.length) {
         output += ' (' + authors.map(function(author){return '@' + author}).join(', ') + ')';
-      else
+      } else if (author) {
         output += " (@" + author + ")";
+      } else if (authorName) {
+        output += " (" + authorName + ")";
+      }
+
     } else { //otherwise link to the commit
@@ -458,0 +484,0 @@ output += "- [" + commit.sha.substr(0, 7) + "](" + commit.html_url + ") " + message;

CHANGELOG.md

 ## Change Log
 
-### v1.0.4 (2016/08/19 08:25 +00:00)
+### v1.1.0 (2017/03/16 21:18 +00:00)
+- [#64](https://github.com/lalitkapoor/github-changes/pull/64) Support for squash and merge (@304NotModified, @lalitkapoor)
+
+### v1.0.3 (2016/08/19 08:25 +00:00)
 - [#55](https://github.com/lalitkapoor/github-changes/pull/55) Update README with correct links! (@PunkChameleon)
@@ -5,0 +8,0 @@ - [#59](https://github.com/lalitkapoor/github-changes/pull/59) added --time-zone option (@YuG1224)

package.json

 {
   "name": "github-changes",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "generate changelog for github repos",
@@ -5,0 +5,0 @@ "main": "./bin/index.js",

README.md

@@ -29,2 +29,3 @@ github-changes [![NPM version](https://badge.fury.io/js/github-changes.png)](http://badge.fury.io/js/github-changes)
    -t, --title         title to appear in the top of the changelog  [Change Log]
+   -z, --time-zone     time zone  [UTC]
    -m, --date-format   date format  [(YYYY/MM/DD HH:mm Z)]
@@ -50,3 +51,3 @@ -v, --verbose       output details
 ```bash
-github-changes -o goodybag -r mongo-sql -a --only-pulls --use-commit-body
+github-changes -o lalitkapoor -r github-changes -a --only-pulls --use-commit-body
 ```
@@ -57,33 +58,30 @@
 
-    ### v2.3.3 (2014/02/20 00:22 +00:00)
-    - [#83](https://github.com/goodybag/mongo-sql/pull/83) Buffer not defined in browser (@jrf0110)
+    ### v1.0.3 (2016/08/19 08:25 +00:00)
+    - [#59](https://github.com/lalitkapoor/github-changes/pull/59) added --time-zone option (@YuG1224)
+    - [#55](https://github.com/lalitkapoor/github-changes/pull/55) Update README with correct links! (@PunkChameleon)
 
-    ### v2.3.2 (2014/02/19 23:54 +00:00)
-    - [#82](https://github.com/goodybag/mongo-sql/pull/82) Preserve Buffer query values. (@alexmingoia)
+    ### v1.0.2 (2016/02/22 00:53 +00:00)
+    - [#53](https://github.com/lalitkapoor/github-changes/pull/53) added --for-tag option to generate changelog for single tag (@ivpusic)
 
-    ### v2.3.1 (2014/02/08 23:01 +00:00)
-    - [#81](https://github.com/goodybag/mongo-sql/pull/81) Casts + JSON derefs are malformed during the automated quoting (@jrf0110)
+    ### v1.0.1 (2016/01/12 01:52 +00:00)
+    - [#52](https://github.com/lalitkapoor/github-changes/pull/52) Update ghauth dependency (@nunorafaelrocha)
 
-    ### v2.3.0 (2014/01/29 22:16 +00:00)
-    - [#25](https://github.com/goodybag/mongo-sql/pull/25) Querying on JSON (@jrf0110)
+    ### v1.0.0 (2015/04/12 14:32 +00:00)
+    - [#47](https://github.com/lalitkapoor/github-changes/pull/47) Add a Gitter chat badge to README.md (@gitter-badger)
 
-    ### v2.2.14 (2014/01/27 22:35 +00:00)
-    - [#78](https://github.com/goodybag/mongo-sql/pull/78) adding npm info (@lalitkapoor)
-    - [#80](https://github.com/goodybag/mongo-sql/pull/80) $nin does not support Array (@jrf0110)
+    ### v0.0.16 (2014/11/26 11:15 +00:00)
+    - [#30](https://github.com/lalitkapoor/github-changes/pull/30) show changes between two tags (@lalitkapoor)
 
-    ### v2.2.13 (2014/01/13 17:40 +00:00)
-    - [#77](https://github.com/goodybag/mongo-sql/pull/77) Expose `quoteColumn` on root namespace (@prestonp)
+    ### v0.0.14 (2014/11/06 02:45 +00:00)
+    - [#41](https://github.com/lalitkapoor/github-changes/pull/41) Aesthetic fixes (@nylen)
+    - [#46](https://github.com/lalitkapoor/github-changes/pull/46) Add option to allow specifying the date format (@fixe)
+    - [#45](https://github.com/lalitkapoor/github-changes/pull/45) Add option to allow specifying the changelog title (@fixe)
 
-    ### v2.2.12 (2013/11/26 20:57 +00:00)
-    - [#76](https://github.com/goodybag/mongo-sql/pull/76) Dates not handled correctly in update where clause (@jrf0110)
+    ### v0.0.13 (2014/10/26 23:25 +00:00)
+    - [#42](https://github.com/lalitkapoor/github-changes/pull/42) Fetch 100 tags per page (only 1 page for now) (@nylen)
 
-    ### v2.2.11 (2013/11/15 15:46 +00:00)
-    - [#74](https://github.com/goodybag/mongo-sql/pull/74) Drop constraint action needs options (@jrf0110)
+    ### v0.0.12 (2014/09/02 05:37 +00:00)
+    - [#36](https://github.com/lalitkapoor/github-changes/pull/36) PR links point to https://null/... (@lalitkapoor)
+    - [#35](https://github.com/lalitkapoor/github-changes/pull/35) Update README.md with Grunt Plugin Info (@PunkChameleon)
 
-    ### v2.2.10 (2013/11/15 06:03 +00:00)
-    - [#73](https://github.com/goodybag/mongo-sql/pull/73) Action helper should accept an array of actions (@jrf0110)
-
-    ### v2.2.9 (2013/11/12 05:05 +00:00)
-    - [#70](https://github.com/goodybag/mongo-sql/pull/70) Window functions (@ProCynic)
-
     ...
@@ -143,1 +141,8 @@
 For further details and specifics on how to use (and to contribute), see [grunt-github-changes](https://github.com/PunkChameleon/grunt-github-changes).
+
+### FAQ
+
+#### How are squashed pull request matched?
+
+When a pull request is merged with "Squash and merge", there isn't a merge commit. 
+By checking the commit message for ` (#123)` etc, we can match the correct pull request.

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

33062

increased by4.98%

Lines of code

524

increased by3.97%

Number of lines in readme file

144

increased by2.86%

No dependency changes