Skip to main content

A very simple script to generate a changelog from a repo with Conventional-Commits-compatible commit messages.

Project description

gen_changelog

gen_changelog is a very simple script that generates a changelog from a repository with commit messages compatible with Conventional Commits. The main difference of this script from gitchangelog is that this script will generate sections from dates/months instead of git tags of versions.

Usage

Just run it in the root of your repository:

$ ./gen_changelog "Your project's name"

You're done.

Customization

You can customize the sections you want in the changelog by passing the --categories parameter:

$ ./gen_changelog --categories "add:Added|rem:Removed|chg:Changed|cs:CS:GO stuff"

With pre-commit

To use this with pre-commit, add this to your .pre-commit-config.yaml:

- repo: https://gitlab.com/stavros/gen_changelog.git
  rev: ccc6fa1dbe1a937c9b729e356b5fd91bf9d59ca4
  hooks:
  - id: gen-changelog
    stages: [commit]

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

gen_changelog-0.1.1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

gen_changelog-0.1.1-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file gen_changelog-0.1.1.tar.gz.

File metadata

  • Download URL: gen_changelog-0.1.1.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.0.1 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for gen_changelog-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1e7d867d76b757fa1a9c71149dc9ac35c9069c7a468720872c2f989249abfa27
MD5 2c6ac561050b6c27df4fad9814b65db9
BLAKE2b-256 676c98bf2711c4a2d6e8a8594c8ee47bc91daca26ad88aa85359bf3ecbdd566b

See more details on using hashes here.

Provenance

File details

Details for the file gen_changelog-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gen_changelog-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.0.1 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for gen_changelog-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8c7099f21753a5223e4036a6bf29a67d55e90f7165d463ef75d790985ddc855
MD5 9ed2ae3a22f5911aac4f6f0528dc219c
BLAKE2b-256 890021391d11aa43f888a5192f473739370d45544db5c6c905653cf91661e79a

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