A changelog update cli tool
Project description
changelog-cli
This tool is aiming at reducing conflicts in trunk-based or feature-based git developement.
Install
> pip install cli_changelog
Usage
usage: changelog [-h] [-c message] [-r version] [-f FILENAME]
Changelog administration tool.
optional arguments:
-h, --help show this help message and exit
-c message, --create message
creates an entry with this actual message to be added
to the changelog
-r version, --release version
releases the changelog byt gathering all entries
-f FILENAME, --filename FILENAME
the filename to put the message in if you don't want
to use the branch name
-t, --commit commit the created/deleted/modified files by this
command
Flow example
> changelog -c "Initial import" -f init
> changelog -c "Added readme content" -f readme
will give this layout
├── CHANGELOG.md
├── README.md
├── changelog.py
└── changelogs/
│ └──── unreleased/
│ ├──── init.md
│ └──── readme.md
└── requirements.txt
And now releasing version 1.0.0 like this
> changelog -r 1.0.0
will give this layout
├── CHANGELOG.md
├── README.md
├── changelog.py
└── requirements.txt
Requirements
- tested with python3
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cli-changelog-1.3.0.tar.gz
(2.7 kB
view details)
File details
Details for the file cli-changelog-1.3.0.tar.gz
.
File metadata
- Download URL: cli-changelog-1.3.0.tar.gz
- Upload date:
- Size: 2.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | be12639151678596e89a99c016fbf9c4982467d9e54b3cf39b8646851b2a5146 |
|
MD5 | 34a9abfb79c4d9487ad0b441113e2a02 |
|
BLAKE2b-256 | 0022054769c862e29991c8f7c6432694a1e6a5e01c2579069fa314cce9cda700 |