git-cliff

Generate changelogs for your project with a generated cliff.toml from cliff-template.toml or provide a custom template. This eliminates the need to maintain multiple project cliff.toml files.

Features

• Generates changelogs using git-cliff.
• Utilizes a generic cliff-template.toml for easy configuration.
• Supports custom templates via file path or URL.
• Dynamically replaces values via Github context object
• Falls back to project's cliff.toml if one exists

Usage

...
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v4with:
fetch-depth: 0
- name: Run git-cliffuses: tj-actions/git-cliff@7b2afa2d0b650c50cde5a7b173a74753ecd29072 # v2

Inputs

- uses: tj-actions/git-cliff@7b2afa2d0b650c50cde5a7b173a74753ecd29072 # v2id: git-cliffwith:
# Output file# Type: string# Default: "HISTORY.md"output: ''# Path or URL to the # template `cliff.toml` config file. See # [`cliff-template.toml`](./cliff-template.toml) for a working example. # **NOTE:** Only the `REPOSITORY_URL` is # substituted. # Type: stringtemplate-config: ''# GITHUB_TOKEN or a Repo scoped # PAT # Type: string# Default: "${{ github.token }}"token: ''

• Free software: MIT license

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

Credits

This package was created with Cookiecutter using cookiecutter-action

• git-cliff

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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Michael Kriese 💻

Raphael Boidol 📖

This project follows the all-contributors specification. Contributions of any kind welcome!