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 - 18:52:52)
- Initial commit
0.0.2 (08/30/2021 - 18:57:44)
- Add basic way to get details from
git log
0.0.3 (08/30/2021 - 21:57:30)
- Get content required for a CHANGELOG
0.0.4 (08/30/2021 - 22:06:24)
- Add version numbers for each change
- Rename variable names
0.0.5 (08/30/2021 - 22:09:10)
- Get the number of commits automatically
- Add three digit version numbers
0.0.6 (08/30/2021 - 22:26:07)
- Wrap everything inside a class
- Print run time at the end
0.0.7 (08/30/2021 - 22:45:15)
- Get the commit info from the trunk branch
- Add a destructor method
- Add docstrings
0.0.8 (08/30/2021 - 22:50:04)
- Add pre-commit for linting, isort and flake8
0.0.9 (08/30/2021 - 23:07:49)
- 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 - 23:17:14)
- onboard docs.yml but only prints a statement
0.1.1 (08/30/2021 - 23:24:27)
- auto upload to pypi when tagged a release version
0.1.2 (08/30/2021 - 23:59:10)
- 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 - 00:02:16)
- revert change on python-publish.yml
0.1.4 (08/31/2021 - 00:03:04)
- auto upload to pypi when tagged a release version
0.1.5 (08/31/2021 - 01:22:22)
- Alter time counter in destructor method
- Update README.md, .gitignore, CHANGELOG
- Bump version
0.1.6 (08/31/2021 - 01:29:57)
- Update sample code in README.md
- Bump version to 0.1.6
0.1.7 (08/31/2021 - 01:35:09)
- bump version to run build
0.1.8 (08/31/2021 - 07:56:10)
- Support up to 6 digit version numbers
- Fix versions() getting called repeatedly
- Add logger info
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.1.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbee48ab60ae50c3e2bc83022e4c2fc19ac83d54ca5ddf91c84ced203ddff49e |
|
MD5 | 3d03235a7a8939d4ff109d480dba45d9 |
|
BLAKE2b-256 | 1a2e76ef2397567ab010011c6c1d0104e82182045c6e9e13cacc49db76f6736f |
Close
Hashes for changelog_generator-0.1.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2430e42b751ebdb35bd2d2cab45f674f87ab3facaf961981d21b481665c2c2f |
|
MD5 | 395335acc3388d60823eb20a1779663e |
|
BLAKE2b-256 | 86fdccb08e0f46ce2e3d54e3d90fdc92b56eb886740eafaa9f2073b8ece75132 |