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

GitHub Action

Conventional changelog generator

v1.0.5

Conventional changelog generator

play

Conventional changelog generator

Generate a changelog based on the conventional commit history for the latest tag

Installation

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

 
              
- name: Conventional changelog generator

              
  uses: quant-eagle/conventional-changelog-generator@v1.0.5
Learn more about this action in quant-eagle/conventional-changelog-generator

Choose a version

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/conventional-changelog-generator@v1.0.5
with:
  token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name Description Required Example
commit-types Commit -> changelog mapping Yes feat:Features,bug:Bug Fixes
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.