Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
layers

GitHub Action

Keep-a-Changelog Action

v2.2.1

Keep-a-Changelog Action

layers

Keep-a-Changelog Action

Performs operations on changelogs that are in Keep-a-Changelog format: bump the version, query release info

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Keep-a-Changelog Action

              
  uses: release-flow/[email protected]
Learn more about this action in release-flow/keep-a-changelog-action

Choose a version

Keep-a-Changelog Action

A GitHub Action that performs various operations on changelogs that adhere to keep-a-changelog and Semantic Versioning conventions.

Commands

bump

Updates a changelog by converting the '[Unreleased]' section to the latest release number. The release number is automatically incremented according to the action parameters.

query

Queries release information for a specified version from a changelog.

Updating from V1 to V2

The upgrade is fairly straightforward, documented here.

License

The scripts and documentation in this project are released under the MIT License.