Skip to content

Conventional changelog generator

Actions
Generate a changelog based on the conventional commit history for the latest tag
v1.0.6-release
Latest
Star (8)

version

✏️ 📃 Conventional Commit Changelog Generator (GitHub Action)

Automatically generate the changelog based on your commit convention for your latest tagged version with Changelog Generator.

The changelog is accessible as action output available to other actions via output.

Example usage

uses: Helmisek/[email protected]
with:
  token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name Description Required Example
commit-types Commit -> changelog mapping Yes feat:Features,bug:Bug Fixes
current-tag Currently selected tag No v1.0.0+1-internal
template-path Path to a custom template to use No CHANGELOG.tpl.md
tag-regex A custom regex to filter versions by No internal

Outputs

Name Description
changelog Contents of generated change log.

Modifications

If you want to use your own custom template, just copy the CHANGELOG.tpl.md into your project, modify it and add the file path to the action configuration.

Conventional changelog generator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Generate a changelog based on the conventional commit history for the latest tag
v1.0.6-release
Latest

Conventional changelog generator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.