Skip to main content

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.

Files for cli-changelog, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size cli-changelog-1.2.0.tar.gz (2.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page