Skip to main content

Simple scripts for creating and compiling changelog files.

Project description

These Python2/3 compatible scripts can create and compile changelog files from different git branches without conflicts.

Inspired by GitLab team approach to changelogs. https://docs.gitlab.com/ee/development/changelog.html

How to install:

pip install changelog-helper

Info

Adding changelog entities:

add-changelog.py [-h] [--author AUTHOR] [--amend] [--force] [title]

Generate a changelog entry file in git project root.

positional arguments:
  title

optional arguments:
  -h, --help       show this help message and exit
  --author AUTHOR
  --amend
  --force

Release version and compile changelog:

release-changelog [-h] [--inline INLINE] [--rebuild] [version]

Generate CHANGELOG.md file from changelog yml files.

positional arguments:
  version          New version, in format like v5.6.7

optional arguments:
  -h, --help       show this help message and exit
  --inline INLINE  Inline minor release, with single change
  --rebuild

You can move your old changelog to changelogs/archive.md, and it will be appended to CHANGELOG.md

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

changelog-helper-1.1.0.tar.gz (9.6 kB view details)

Uploaded Source

File details

Details for the file changelog-helper-1.1.0.tar.gz.

File metadata

File hashes

Hashes for changelog-helper-1.1.0.tar.gz
Algorithm Hash digest
SHA256 37d1675fbb17ee0adc5c58a7e46a643e974a9062808bb26294dcb6a5ec72d3bc
MD5 76e1b0939f71030e0b22a7c8c9c84d5f
BLAKE2b-256 0d0e66a7bd27ad3f70cae76a775674a81ae412a8e8ecc3976a9aea62acf9fbe4

See more details on using hashes here.

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