Back to Git Cliff

git-cliff-action

website/docs/github-actions/git-cliff-action.md

2.13.1811 B
Original Source

git-cliff-action

It is possible to generate changelogs using GitHub Actions via git-cliff-action.

yml
- name: Check out repository
  uses: actions/checkout@v3
  with:
    fetch-depth: 0

- name: Generate a changelog
  uses: orhun/git-cliff-action@v4
  with:
    config: cliff.toml
    args: --verbose
  env:
    OUTPUT: CHANGELOG.md
    GITHUB_REPO: ${{ github.repository }}

See the repository for other examples.

Also, see the continuous deployment workflow of this project which sets the release notes for GitHub releases using this action.