Command line utility for keeping your changelog tidy
Project description
Changelog Keeper
Command line utility for keeping your changelog tidy
About the project
This tool aims to:
- make your changelog file standardized; and
- reduce the time spent on updating the changelog file by providing a suite of basic commands.
The Changelog standard is based on the keep-a-changelog convention with few adjustments, described in this document.
It is also possible (with some additional scripting/tooling) to incorporate this utility into your Continuous Integration & Continuous Delivery routines. There are few things to consider, mentioned in this document.
Getting started
Prerequisites
- Python >= 3.7
- Pip
Installation
# general installation
pip install changelog-keeper
# with specific version
pip install changelog-keeper==1.0.0
Usage
Changelog Keeper provides five simple commands allowing basic operations on the changelog file:
# Create new, empty changelog file
clkpr create [-f PATH]
# Add new entry to the changelog file
clkpr add [-f PATH] CHANGE_TYPE ENTRY
# Validate and (if needed and possible) fix the changelog file
clkpr check [-f PATH]
# Release a version (with optional link)
clkpr release [-f PATH] [-r URL] VERSION_NAME
# Yank released version
clkpr yank [-f PATH] VERSION_NAME
# For more details, one can check the help messages for the tool: `clkpr -h`
# and for a particular command: `clkpr <command> -h`
Contributing
Please have a look into CONTRIBUTING file for detailed suggestions regarding project contribution.
License
Distributed under the MIT License. See LICENSE file for more information.
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
Hashes for changelog_keeper-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ec8b4614be97c4cb566f7324a7b040dc6e227e3bcb829efcb2b24234abd093e |
|
MD5 | 6015381bc290815d58387511f1edb552 |
|
BLAKE2b-256 | 77fa50d73f08934f51d161f49176c4c1aa1c5ac0f635096eacb0260054323b61 |