Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

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.

Files for changelog_helper, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size changelog-helper-1.1.0.tar.gz (9.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page