Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.16 KB

README.rst

File metadata and controls

52 lines (34 loc) · 1.16 KB
Raw

changelog-helper

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