github-changes Can Auto-Generate CHANGELOG.md from Commit Messages

Tadashi Shigeoka ·  Tue, August 14, 2018

github-changes was convenient for auto-generating CHANGELOG.md from git commit messages, so I’ll introduce it.

GitHub

Install github-changes

npm install -g github-changes

How to Use github-changes

(Example) Using github-changes to Pull Request CHANGELOG.md

github-changes -o request -r request -b master \\
--date-format '(YYYY/MM/DD)' --only-pulls --use-commit-body --auth

Before updating the request module to the latest version with npm update, I checked the Change Log and found it wasn’t updated, so I used github-changes to submit a Pull Request to CHANGELOG.md.

I specified the —date-format ‘(YYYY/MM/DD)’ option to match the format of the existing CHANGELOG.md.

$ git show 84d39ff4104b4259479d040910efe4917c21ca53
commit 84d39ff4104b4259479d040910efe4917c21ca53 (HEAD -> update-changelog-v2.88.0, origin/update-changelog-v2.88.0)
Author: Tadashi Shigeoka 
Date:   Wed Aug 15 14:14:26 2018 +0900

    :memo: Updated the Change Log for v2.88.0 (2018/08/10)
    
    Used the following command:
    
    ```
    github-changes -o request -r request -b master --date-format '(YYYY/MM/DD)' --only-pulls --use-commit-body --auth
    ```

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 751514d..d3ffcd0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,13 @@
 ## Change Log
 
+### v2.88.0 (2018/08/10)
+- [#2996](https://github.com/request/request/pull/2996) fix(uuid): import versioned uuid (@kwonoj)
+- [#2994](https://github.com/request/request/pull/2994) Update to oauth-sign 0.9.0 (@dlecocq)
+- [#2993](https://github.com/request/request/pull/2993) Fix header tests (@simov)
+- [#2904](https://github.com/request/request/pull/2904) #515, #2894 Strip port suffix from Host header if the protocol is known. (#2904) (@paambaati)
+- [#2791](https://github.com/request/request/pull/2791) Improve AWS SigV4 support. (#2791) (@vikhyat)
+- [#2977](https://github.com/request/request/pull/2977) Update test certificates (@simov)
+
 ### v2.87.0 (2018/05/21)
 - [#2943](https://github.com/request/request/pull/2943) Replace hawk dependency with a local implemenation (#2943) (@hueniverse)

That’s all from the Gemba where I want to auto-generate CHANGELOG.md from git commit messages.