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.tomlfor 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-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Run git-cliff
uses: tj-actions/git-cliff@v1Inputs
| 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. |
- 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
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!