Simple git changelog file generator
Project description
simple-git-changelog
simple-git-changelog is a command-line tool for creating and updating a git project's changelog file.
To create your project's changelog file, run simple-git-changelog in your project's root directory:
$ simple-git-changelog
By default, the "CHANGELOG.md" file is created with your project's changes. For example:
## 2021-04-30
- [abcdf0](https://github.com/username/project-name/commit/abcdf0) most recent change
- [abcdef](https://github.com/username/project-name/commit/abcdef) previous change
Edit "CHANGELOG.md" as appropriate and commit. To update your changelog file later, simply run simple-git-changelog again. Change items for new git changes are added to the top of the changelog:
## 2021-05-01
- [abcdf1](https://github.com/username/project-name/commit/abcdf1) one more thing
## 2021-04-30
- [abcdf0](https://github.com/username/project-name/commit/abcdf0) most recent change
- [abcdef](https://github.com/username/project-name/commit/abcdef) previous change
Usage
usage: simple-git-changelog [-h] [-o FILE]
options:
-h, --help show this help message and exit
-o FILE specify the change log file (default is "CHANGELOG.md")
Development
This project is developed using Python Build. It was started using python-package-template as follows:
template-specialize python-package-template/template/ simple-git-changelog/ \
-k package simple-git-changelog \
-k name "Craig A. Hobbs" \
-k email "craigahobbs@gmail.com" \
-k github "craigahobbs" \
-k nodoc 1
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
Close
Hashes for simple-git-changelog-1.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc9db6c050de572a591bc391a90f3dadf09e18f64b7ce3793dc7d0c0c68dcd3f |
|
MD5 | 6c594aea236639eff778b9ad2c30b7df |
|
BLAKE2b-256 | 43394738b5254f748257471f513590cd47dee61e222a01b49c18277e710ada76 |