changeloggh is a command line tool
to generate and administrate changelog files for GitHub
according to https://keepachangelog.com/en/1.1.0/.
|
|
|
pipx install changelogghUpgrade with pip:
pipx upgrade changelogghAlias clgh
Help:
changeloggh --helpVersion:
changeloggh --versionInit CHANGELOG:
changeloggh init <GitHub Repo>Add changes:
changeloggh <added|changed|deprecated|removed|fixed|
7CEC
security> "entry 1" "entry 2" ...Bump version:
changeloggh bump <major|minor|patch>Release version:
changeloggh release <version>Import MD:
changeloggh importPrint current version:
changeloggh latestPrint CHANGELOG:
changeloggh print --format <rich|json|text>Live CHANGELOG version:
changeloggh liveInstalling poetry:
pipx install poetryInstalling development dependencies:
poetry installInstalling pre-commit:
poetry run pre-commit installRunning unit tests:
poetry run python -m scripts.testsApplying code styles:
poetry run python -m scripts.stylesRunning code analysis:
poetry run python -m scripts.analyzeRunning code coverage:
poetry run python -m scripts.coverageRunning cli using poetry:
poetry run changelogghpoetry run python -m scripts.bump --help
poetry run python -m scripts.bump <major|minor|patch>A lot of tools (like yarn, npm, poetry ,etc) use lock files to
ensures that installations remain identical and reproducible
across systems. A lock file saves important metadata, so that is why
changeloggh is using this approach. The changelog.lock file
saves and structures changelog data in json format.
It's highly recommended to commit the changelog.lock file into your repository.
- Does not support other format besides
semvermajor.minor.patch, ex.: 1.1.1. - It needs a
changelog.lock.