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
pip install changelog-generator
Navigate to the repository, launch a scratch file and run:
from changemaker.generator import Generator
Generator().run()
Pre-Commit
Install pre-commit
to run flake8
and isort
for linting and sphinx
for documentation generator.
pip3 install pre-commit sphinx recommonmark
pre-commit run --all-files
Runbook
https://thevickypedia.github.io/changelog-generator/
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
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1560fbbc481087e78c3f04b413be601f670b941ac18169c7aab2da280c272a2a |
|
MD5 | e44b03dbcb45a06106b8170f41e3a98f |
|
BLAKE2b-256 | cbb681c632ca4d0be9251d550e10a2c6029f7626a93a98703d24dc3661a01c68 |
Close
Hashes for changelog_generator-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02f86cda85095a714fd82a94f15df5455e31da531ba29fef870ec4a827513c3e |
|
MD5 | 83b29f0689cb5465f1bcbcb8d9f49389 |
|
BLAKE2b-256 | 6d3ccd7761e7f1e7bc5d51b474bde2ada8e93a23359067e1e3466aa0c80a06e5 |