Skip to content

Generates git changelog for Conventional Commits

License

Notifications You must be signed in to change notification settings

AliYmn/changelog

Repository files navigation

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!