Generates changelogs between commit hashes and creates a clean markdown file with commit prefix sections
Changeling helps you to generate changelogs between commit hashes easily. Depending on your commit message prefixes, your changelog will be created with markdown sections and commit messages with corresponding hashes.
- Requirements
- Clone or Download this repository
- Within the directory, from your favorite terminal
npm installnpm link(might ask for permission depending on your OS)
- Now you can use
clogorchangelogright from your terminal!
In order to use the app, please follow How To Install steps above.
When you complete installation, you can run commands below
| Command | Description |
|---|---|
| clog | Run Changeling |
| clog -s | Open Settings File In Editor |
| clog -h | Display This Help |
Whenever you run clog app will run by default. You need to fill required fields to generate your changelog. When you are done, changelog will be saved in your git directory.
| Settings | Description |
|---|---|
| Title | Title for your new changelog (ie. Milestone 5) |
| From Commit Hash | Pick from which commit you want to include commits |
| To Commit Hash | Pick which commit you want to end fetching commits |
| Append or Create | If you generated a changelog before, you can append to it or create a new changelog |
| Check Settings | Check your settings before creating |
You can update settings by using clog -s command. This will open config file within your beloved editor.
Default Settings:
| Key | Value |
|---|---|
| prefixes | Add |
| Remove | |
| Improve | |
| Change | |
| Update | |
| Refactor | |
| Fix | |
| defaultFileName | Changelog.md |
| tempFileName | tempLog.txt |
This project is licensed under the MIT License - see the LICENSE.md file for details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent