/changelog

Generates git changelog for Conventional Commits

Primary LanguagePythonMIT LicenseMIT

Changelogs Generator

Hey! This Package is a changelogs-cli package that creates automatic changelogs that supports Conventional Commits. Since we use Bitbucket, we needed something like this and I wanted to share it publicly in case you need it too.

Emoji Support

If comments comply with conventional commit rules, they are supported with emoji.

[
    "feat": "โœ…",
    "fix": "๐Ÿš€",
    "build": "๐Ÿ’š",
    "chore": "๐Ÿš€",
    "docs": "๐Ÿ“",
    "style": "๐ŸŽจ",
    "refactor": "๐Ÿ‘ท",
    "perf": "โšก๏ธ",
    "test": "๐Ÿงช",
    "merge": "๐ŸŽ‰",
    "revert": "โช๏ธ"
]  

Installing

pip install changelogs-cli

Example

First, let's get into the current your repository.

Example; cd /home/repository/

Example usage is as follows. changelogs example/commits/ (this should be commit link to show reference on changelogs md.)

Demo

i will use this repo for example ; https://github.com/qoomon/git-conventional-commits


The sample check logs are as follows : Check it!