ChangeLog Keeper
A CLI tool that helps you with maintaining CHANGELOG.md
using keep a changelog format.
Resources
GitHub action quickstart
Use taminomara/cl-keeper@v1 to parse a change log. It takes git tag
(parameter version) and returns text and other release info.
See details in documentation.
Example:
name: Create a release
on:
push:
tags:
- 'v*'
jobs:
release:
- name: Checkout source
uses: actions/checkout@v4
- id: changelog
name: Parse Changelog
uses: taminomara/cl-keeper@v1
with:
version: ${{ github.ref }}
- name: Create GitHub release
uses: softprops/action-gh-release@v2
with:
prerelease: ${{ fromJSON(steps.changelog.outputs.is-pre-release) }}
draft: ${{ fromJSON(steps.changelog.outputs.is-unreleased) }}
body: |
## Changelog
${{ steps.changelog.outputs.text }}
Installation
Install via pipx:
pipx install cl-keeper
Release files for cl-keeper 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cl_keeper-1.0.1.tar.gz | 123.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cl_keeper-1.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 165.7 kB
Release files / cl_keeper-1.0.1.tar.gz
| Download URL | cl_keeper-1.0.1.tar.gz |
|---|---|
| Size | 123.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d0f94b9e50742a904aa170030f0a713f3883fa525e6a380a1692d7ce2aacfa89
|
|
BLAKE2b-256 checksum How to use checksums |
7c18fcc892fc4412a9b9240cbaca4f00b331b55def6579581aecae2bb3c834c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / cl_keeper-1.0.1-py3-none-any.whl
| Download URL | cl_keeper-1.0.1-py3-none-any.whl |
|---|---|
| Size | 42.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45aedd93e1d48b30035d608a9f3112a3af4ee3d17023548a39940c80b87053a4
|
|
BLAKE2b-256 checksum How to use checksums |
c0b054616bfe1aeba72efbb22e571a1c7c3d2d42b5fa74ae086d1af51fa91ebd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|