Skip to main content

Generates git changelog for Conventional Commits

Project description

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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelogs-cli-1.0.0.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file changelogs-cli-1.0.0.tar.gz.

File metadata

  • Download URL: changelogs-cli-1.0.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for changelogs-cli-1.0.0.tar.gz
Algorithm Hash digest
SHA256 687459f6da5d674c2e675697b1fe15d0d87f2bc4c99ed4308fc8fd7bdbd56009
MD5 b291a83dabbdb5deb4f2504c10dfb7c3
BLAKE2b-256 d07f257aa941f0aa7779eda2159d3320c32cce400e5cf568a59a4b95e8e2c11f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page