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
Regular CHANGELOG in debug mode
changelog debug
CHANGELOG in reverse order
changelog reverse
Use a branch other than master
or main
changelog -b <branch name>
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.7 (11/10/2022)
- Add optional branch name to pull branch specific commits
- Add exception handlers and print messages appropriately
- Enable debug mode by command
- Restructure code and cleanup
- Enable pypi workflow on commit
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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30aa1a434acbe0a5055ecbe112e9a78fb6c59c88aa305cd1313f29af049cb1f7 |
|
MD5 | 4c5c53b4467ae7710612d4665c811f35 |
|
BLAKE2b-256 | 4579059213b7a92668ca586e2547ed87062fd441b0f475f29d88f312a61adda3 |
Close
Hashes for changelog_generator-0.2.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b2beacc65444de678fc79c6f130bf7b8f7eb8202e90977762860ae05cd3edde |
|
MD5 | dc94af8a8b62da2dd4ee5687a21afbe3 |
|
BLAKE2b-256 | 5db6519aa916a3cc73b787dbd48a8a7ed816d5ea12cada9ef118a801d4b61ccf |