Skip to main content

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]

Release files for gen-changelog 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gen-changelog 0.1.1
File Size Uploaded
gen_changelog-0.1.1.tar.gz 15.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gen-changelog 0.1.1
File Interpreter ABI Platform
gen_changelog-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 30.7 kB

Release files / gen_changelog-0.1.1.tar.gz

Download URL gen_changelog-0.1.1.tar.gz
Size 15.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1e7d867d76b757fa1a9c71149dc9ac35c9069c7a468720872c2f989249abfa27
BLAKE2b-256 checksum
How to use checksums
676c98bf2711c4a2d6e8a8594c8ee47bc91daca26ad88aa85359bf3ecbdd566b
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / gen_changelog-0.1.1-py3-none-any.whl

Download URL gen_changelog-0.1.1-py3-none-any.whl
Size 15.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8c7099f21753a5223e4036a6bf29a67d55e90f7165d463ef75d790985ddc855
BLAKE2b-256 checksum
How to use checksums
890021391d11aa43f888a5192f473739370d45544db5c6c905653cf91661e79a
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page