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
changelog
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.0.1 (08/30/2021)
- Initial commit
0.0.2 (08/30/2021)
- Add basic way to get details from
git log
0.0.3 (08/30/2021)
- Get content required for a CHANGELOG
0.0.4 (08/30/2021)
- Add version numbers for each change
- Rename variable names
0.0.5 (08/30/2021)
- Get the number of commits automatically
- Add three digit version numbers
0.0.6 (08/30/2021)
- Wrap everything inside a class
- Print run time at the end
0.0.7 (08/30/2021)
- Get the commit info from the trunk branch
- Add a destructor method
- Add docstrings
0.0.8 (08/30/2021)
- Add pre-commit for linting, isort and flake8
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.1.0 (08/30/2021)
- onboard docs.yml but only prints a statement
0.1.1 (08/30/2021)
- auto upload to pypi when tagged a release version
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.3 (08/31/2021)
- revert change on python-publish.yml
0.1.4 (08/31/2021)
- auto upload to pypi when tagged a release version
0.1.5 (08/31/2021)
- Alter time counter in destructor method
- Update README.md, .gitignore, CHANGELOG
- Bump version
0.1.6 (08/31/2021)
- Update sample code in README.md
- Bump version to 0.1.6
0.1.7 (08/31/2021)
- bump version to run build
0.1.8 (08/31/2021)
- Support up to 6 digit version numbers
- Fix versions() getting called repeatedly
- Add logger info
0.1.9 (08/31/2021)
- Update CHANGELOG
0.2.0 (08/31/2021)
- Remove timestamp from CHANGELOG
0.2.1 (10/14/2021)
- Add title to the generated CHANGELOG
0.2.2 (10/14/2021)
- Make Change Log the title as a heading
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.4 (10/14/2021)
- Add project urls to pypi package
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0545a3be65eeb56b383f16e2ff50e262a836bd47b4ee953c233eb0be0d8275df |
|
MD5 | a1e63e0f082d55125b0b7d94ab714fac |
|
BLAKE2b-256 | 7068bc459e891aed9bfdb7276264df5bff0f52ac385164176a0e8d1579e25996 |
Close
Hashes for changelog_generator-0.2.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45fed764382c37f22aa9986334b200ebf7751a082a215e1d2c9093324acf5364 |
|
MD5 | 3433fd0fc4da6a4bc26c95bdb2b07a4a |
|
BLAKE2b-256 | 5f1c60a04653f7a00181ba9c8d1bc92dbe3aedf9ecb540f03597a10dc9116b29 |