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.
Create the 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:
# Changelog
## 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. Changes to the changelog title are maintained across updates.
Update the Changelog File
To update your changelog file, simply run simple-git-changelog again. Change items for new git changes are added to the top of the changelog:
# MyProject 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 package is developed using python-build. It was started using python-template as follows:
template-specialize python-template/template/ simple-git-changelog/ -k package simple-git-changelog -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 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
Built Distribution
File details
Details for the file simple_git_changelog-1.1.3.tar.gz
.
File metadata
- Download URL: simple_git_changelog-1.1.3.tar.gz
- Upload date:
- Size: 4.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.13.0rc3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a531051c996b99dcb50a6cba44e8336aaa3296b2a14b8d041ec9ff7e492fe0ef |
|
MD5 | f74dd803c5599be81252448a0cbe03d1 |
|
BLAKE2b-256 | 7ac43feff0877ae57f3bbbaba0ac2853a62de9df5435a2dfd4eba4b52fa9bf86 |
File details
Details for the file simple_git_changelog-1.1.3-py3-none-any.whl
.
File metadata
- Download URL: simple_git_changelog-1.1.3-py3-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.13.0rc3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7013219f4e23072f29a04099f3e009e3f197846e1e1e19b5e6990180162395ac |
|
MD5 | 1f9854e3e60837f2b622c9805b82102f |
|
BLAKE2b-256 | 5c46b427ee4eaa0f004b25d8a44ab8cdbd7e85bb7005711a13221fa8b5a397f8 |