Python module to, generate CHANGELOG from git commit history.
Project description
CHANGELOG generator
Generate CHANGELOG from git commit history
Pypi Module
https://pypi.org/project/changelog-generator/
Usage
Navigate to the repository and run:
pip install changelog-generator
Regular CHANGELOG
changelog
CHANGELOG in reverse order
changelog reverse
Pre-Commit
Install pre-commit
to run flake8
and isort
for linting and sphinx
for documentation generator.
pip install --no-cache --upgrade sphinx pre-commit recommonmark
pre-commit run --all-files
Runbook
License & copyright
© Vignesh Sivanandha Rao, Changelog Generator
Licensed under the MIT License
Change Log
0.2.6 (07/31/2022)
- Optimize versions number generation with list comprehension
- Support version numbers of any extent
- Update type hint
0.2.5 (10/23/2021)
- Add an option to generate
CHANGELOG
in reverse order - Scrap logger and use secho with colors instead
- Abort if version is not bumped
- Generate CHANGELOG in reverse
0.2.4 (10/14/2021)
- Add project urls to pypi package
0.2.3 (10/14/2021)
- Use click to make the changelog-generator to make it as a CLI tool
- Update docstrings and README.md
0.2.2 (10/14/2021)
- Make Change Log the title as a heading
0.2.1 (10/14/2021)
- Add title to the generated CHANGELOG
0.2.0 (08/31/2021)
- Remove timestamp from CHANGELOG
0.1.9 (08/31/2021)
- Update CHANGELOG
0.1.8 (08/31/2021)
- Support up to 6 digit version numbers
- Fix versions() getting called repeatedly
- Add logger info
0.1.7 (08/31/2021)
- bump version to run build
0.1.6 (08/31/2021)
- Update sample code in README.md
- Bump version to 0.1.6
0.1.5 (08/31/2021)
- Alter time counter in destructor method
- Update README.md, .gitignore, CHANGELOG
- Bump version
0.1.4 (08/31/2021)
- auto upload to pypi when tagged a release version
0.1.3 (08/31/2021)
- revert change on python-publish.yml
0.1.2 (08/30/2021)
- Create a pypi package
- Move generator.py within a source directory
- Add init.py, CHANGELOT, LICENSE, MANIFEST.in, setup.cfg, setup.py, version.py
0.1.1 (08/30/2021)
- auto upload to pypi when tagged a release version
0.1.0 (08/30/2021)
- onboard docs.yml but only prints a statement
0.0.9 (08/30/2021)
- Add sphinx documentation
- README markdown and init support for sphinx documentation
- Create gen_docs.sh
- Hook up the doc generation process to pre-commit
0.0.8 (08/30/2021)
- Add pre-commit for linting, isort and flake8
0.0.7 (08/30/2021)
- Get the commit info from the trunk branch
- Add a destructor method
- Add docstrings
0.0.6 (08/30/2021)
- Wrap everything inside a class
- Print run time at the end
0.0.5 (08/30/2021)
- Get the number of commits automatically
- Add three digit version numbers
0.0.4 (08/30/2021)
- Add version numbers for each change
- Rename variable names
0.0.3 (08/30/2021)
- Get content required for a CHANGELOG
0.0.2 (08/30/2021)
- Add basic way to get details from
git log
0.0.1 (08/30/2021)
- Initial commit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for changelog-generator-0.2.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e95f745a36cd0e6296ece86f25267341601b0dd6f333ef888df68ec5bc5abb88 |
|
MD5 | f1bed7e274a61e16dde6a3b34c6bc77e |
|
BLAKE2b-256 | c61150c9c6dddc6f5046878bf35564e75c06d5f1edd3bf61981fe40cdd6f362e |
Close
Hashes for changelog_generator-0.2.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0c7de57e23a44aaf6bc636e794d540e247c2d670109d49b7c14a65c5ea08107 |
|
MD5 | 19682b8abda2b9982d7dbc819fe2baf2 |
|
BLAKE2b-256 | 701a03cc455ab7bd538801ee03dec89877957f838e481c2734cba56669147cdb |