Add how-to-generate-changelog entries

Describing how to generate changelog entries from git commit Changelog: changed
2022-03-15 11:01:54 +09:00
parent 040b83d997
commit 81872fbd3b
2 changed files with 102 additions and 0 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1 +1,61 @@
 # CHANGELOG
+
+Generating changelog entries: please check [GENERATE CHANGELOG](GENERATE-CHANGELOG)
+
+
+## 0.0.2
+### Added
+- [Add custom LICENSE templates](4dd55427f3d47e6d61baaa6e9344b47016d63e18) by @Tony Cho (2022-03-15)
+- [Add scratched templates from Gitlab](ce56f11deefbbdd530bfb48affaba03425e675ed) by @Tony Cho (2022-03-15)
+- [Add shared templates files](8a20398aefa76a3316b2e41a31704f3baabe2fca) by @Nuk (2021-10-27)
+- [Add new directory](1ec6f6826409bd8d9acb99ac00aaba06d77e5236) by @Nuk (2021-10-27)
+- [Add new directory](168de804edd27048821e4737479818e5c8aed4bb) by @Nuk (2021-10-27)
+- [Add new directory](e16cbf713629ad945d1664fdef4587343ff49664) by @Nuk (2021-10-27)
+- [Add new directory](d2ca877b4d642a2ebbe0a2571af0f40f4c6ce7e6) by @Nuk (2021-10-27)
+- [Add new directory](32767c5e157f4575b19bb9b44d44bea95476def3) by @Nuk (2021-10-27)
+
+### Fixed
+- NONE
+
+### Changed
+- [Update LICENSE.txt and README](040b83d997fefde6dcba1eb9f53fce1d2a382182) by @Tony Cho (2022-03-15)
+- [Update LICENSE](7d4863d1f748601d380974c1e9e3ab8272c3794c) by @Nuk (2021-10-27)
+- [Update README.md](6a16cff2d397b320c2a293cf8a0186102ba1a903) by @Nuk (2021-10-27)
+- [Update README.md](e60bc13536d77949b5351731f1e490eea0ceaf7e) by @Nuk (2021-10-27)
+- [Update 'issue_templates'](6f387ede1d7b0ef09c36b5f492dd3fa1e5045ab0) by @Nuk (2021-09-24)
+
+### Deprecated
+- NONE
+
+### Removed
+- NONE
+
+### Other
+- NONE
+
+
+
+## 0.0.1
+### Added
+- [Release v0.0.1](dbfae568649b8355594250e8c0ea4a8ff2858bf8) by @Nuk (2021-09-09)
+- [Add CONTRIBUTING](778a7798eaac7af265f4d3a41913219c1cd3b4c9) by @Nuk (2021-09-09)
+- [Add CHANGELOG](6070f1d9c2786a27856e87239158512c7afc2e18) by @Nuk (2021-09-09)
+- [Add LICENSE](c750beb0e61c5aac1f8c07a00939c7ee1d695f93) by @Nuk (2021-09-09)
+- [Initial commit](11ced4f4014b9df9b10728e9634c69e89909e875) by @Nuk (2021-09-09)
+
+### Fixed
+- NONE
+
+### Changed
+- [Update .gitlab-ci.yml to .gitlab-ci.yml.SAMPLE](a8a7cb7307e8055c96c0d5aa6642f1fb9728dde7) by @Nuk (2021-09-09)
+- [Update .gitlab-ci.yml file](1150d88bb1c293ea7a9534251cc6fc5162426aa8) by @Nuk (2021-09-09)
+
+### Deprecated
+- NONE
+
+### Removed
+- NONE
+
+### Other
+- NONE
+
--- a/GENERATE-CHANGELOG.md
+++ b/GENERATE-CHANGELOG.md
@@ -0,0 +1,42 @@
+## Overview
+Each bullet point, or **entry**, in CHANGELOG.md file is generated from the subject line of a Git commit. Commits are included when they contain ***Changelog*** [Git trailer](https://git-scm.com/docs/git-interpret-trailers). When generating the changelog, author and merge request details are added automatically.
+
+Currently we don't use ***Changelog*** git trailer but recommend following values to apply git trailer with automated changelog generation in future release.
+
+Suggested ***Changelog*** trailer values:
+- added: New Feature
+- fixed: Bug fix
+- changed: Feature change
+- deprecated: New deprecation
+- removed: Feature removal
+- security: Security fix
+- performance: Performance improvement
+- other: Other
+- e.g 1) Git commit message to include in the changelog entries:
+```
+Update something
+
+Now some features improved to avoid critical errors
+
+Changelog: changed
+```
+
+## Generate CHANGELOG.md entries from git command:
+- Under Unix/Linux:
+```
+$> git log --pretty=format:'- [%s](%H) by @%cn (%cs)' | grep -v "Merge"
+```
+- Under Windows:
+```
+CommandPrompt> git log --pretty=format:'- [%s](%H) by @%cn (%cs)' | findstr /v "Merge"
+```
+
+### Generate entries between specific vertion/tags
+```
+$> git log v0.0.1...v0.0.2 --pretty=format:'- [%s](%H) by @%cn (%cs)' | grep -v "Merge"
+```
+
+### Generate entries from last N commits
+```
+$> git log -10 --pretty=format:'- [%s](%H) by @%cn (%cs)' | grep -v "Merge"
+```