changeloggh 0.1.0

changeloggh is a command line tool that generates changelog files for github

changeloggh

changeloggh is a command line tool that generates and administrate changelog files for GitHub according to https://keepachangelog.com/en/1.1.0/.

Installation

Install with pip:

pip install changeloggh

Upgrade with pip:

pip install --upgrade changeloggh

Usage

Alias clgh

Help:

changeloggh --help

Version:

changeloggh --version

Development

Installing poetry:

pip install poetry

Installing development dependencies:

poetry install

Running unit tests:

poetry run python -m scripts.tests

Applying code styles:

poetry run python -m scripts.styles

Running code analysis:

poetry run python -m scripts.analyze

Running code coverage:

poetry run python -m scripts.coverage

Running cli using poetry:

poetry run changeloggh

Release a new version

Check https://python-poetry.org/docs/cli/#version

poetry version <major|minor|patch>
git add -A
git commit -m "bumping version to $(poetry version -s)"
git tag $(poetry version -s)
git push origin main
git push --tags