cl-keeper 1.0.0

A CLI tool for keeping your changelogs tidy

ChangeLog Keeper

A CLI tool that helps you with maintaining CHANGELOG.md using keep a changelog format.

Resources

• Documentation
• Issues
• Source
• PyPi
• Changelog

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