This repository has been archived by the owner on Jul 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 48
How to generate a changelog
Simone Martorelli edited this page Mar 15, 2021
·
1 revision
We use an open source tool, released under MIT license called Finch to generate a changelog out of commit messages. After installing it, make sure that you run it inside the root folder of the project.
finch compare --versions '1.0.0 1.0.1' --build-number 03-23-2020Here is example output of changelog for the new version in Markdown
# 1.0.1 (03-23-2020)
### Features
Implement readme — [Commit](https://github.com/IBM/mac-ibm-enrollment-app/pull/20/commits/b81100137ebcd32078ce21f5bd34225d30864770)
Implement changelog generation — [Commit](https://github.com/IBM/mac-ibm-enrollment-app/pull/20/commits/b81100137ebcd32078ce21f5bd34225d30864770)
### Bug Fixes
Change formating — [Commit](https://github.com/IBM/mac-ibm-enrollment-app/pull/20/commits/b81100137ebcd32078ce21f5bd34225d30864770)
### Platform Improvements
Change formating — [Commit](https://github.ibm.com/jvalentik/catalina-seed/commit/58b08f04167218f14fc5e764211d76fa3e79382a)