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
Metadata
Release files for simple-git-changelog 1.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| simple_git_changelog-1.1.6.tar.gz | 4.3 kB | Without provenance | Details for simple_git_changelog-1.1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| simple_git_changelog-1.1.6-py3-none-any.whl | Python 3 | none | any | Details for simple_git_changelog-1.1.6-py3-none-any.whl |
Total release size: 9.6 kB
Release files / simple_git_changelog-1.1.6.tar.gz
| Download URL | simple_git_changelog-1.1.6.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
56a3ed74398c71725acd2b7ccdd2db85c7280ff847ab06b7cb921712a8039cdb
|
|
BLAKE2b-256 checksum How to use checksums |
34e639c827b02e068e1f353ececd0e0d0c536adb469eec8b045bf7da47bfcbcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / simple_git_changelog-1.1.6-py3-none-any.whl
| Download URL | simple_git_changelog-1.1.6-py3-none-any.whl |
|---|---|
| Size | 5.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b6a6c556ca43e3aceed52727beb26657dffb1d3f467a5d9a48f8b57fc5271e39
|
|
BLAKE2b-256 checksum How to use checksums |
8553beb5b2480c3f54c15d557e4d0ae89be3ed25b26eab6d5c239cee3ecf43e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Security for simple-git-changelog 1.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.