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

GitHub Action

Changelogs generated with git-cliff

v1.4.1

Changelogs generated with git-cliff

check-square

Changelogs generated with git-cliff

Generate Changelog with a customized template

Installation

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

              
- name: Changelogs generated with git-cliff

              
  uses: tj-actions/git-cliff@v1.4.1
Learn more about this action in tj-actions/git-cliff

Choose a version

Ubuntu Public workflows that use this action.

CI Update release version.

git-cliff

Generate changelogs for your project with a customized cliff.toml or provide a custom template.

Features

  • Utilizes the cliff-template.toml and dynamically replaces values via github context object and runs git-cliff
  • Provide your own custom template either via a file path or URL

Usage

...
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Run git-cliff
        uses: tj-actions/git-cliff@v1

Inputs

INPUT TYPE REQUIRED DEFAULT DESCRIPTION
args string false "--verbose" Extra args passed directly to git-cliff
output string false "HISTORY.md" Output file
template-config string false Path or URL to the template
cliff.toml config file. See cliff-template.toml for a working example. NOTE: Only the
REPOSITORY_URL is substituted.

If you feel generous and want to show some extra appreciation:

Buy me a coffee

Credits

This package was created with Cookiecutter using cookiecutter-action

Report Bugs

Report bugs at https://github.com/tj-actions/git-cliff/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your workflow that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.