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
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
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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3de5774b63ecc55b1fb956bed7575774652de2f7908bea30c5783a465d815e1 |
|
MD5 | c9e3dbdb62f167916b4d39da17623a97 |
|
BLAKE2b-256 | e4b8a6a4efbb36e296a3773270a35d396eaeaf592f9f86baff7e0faf9d0359d5 |
Close
Hashes for changelog_generator-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87ad2c16f2c11ee771a710591ee03cd3f3846371d615d6aac7f93d45a8e14329 |
|
MD5 | 43800b5d7e7b505d6e48e6ad61c57338 |
|
BLAKE2b-256 | 917f32c6acd19159394ac55599a2c745a7c8ce3a7acb582c643a947bd0256ec6 |