Skip to content

Commit

Permalink
docs(readme): add tj-actions/git-cliff to the list of actions (#152)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackton1 authored Apr 9, 2023
1 parent 9fa5dd4 commit 2520dd2
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,24 @@ While `git-cliff-action` uses the Docker image generated by [docker.yml](https:/

See a practical example [here](https://github.com/autowarefoundation/autoware-github-actions/blob/v1/generate-changelog/action.yaml).

### tj-actions/git-cliff

[tj-actions/git-cliff](https://github.com/tj-actions/git-cliff) is another GitHub Action that you can use to generate changelogs for your project.

It uses a generic `cliff-template.toml` without the need to maintain multiple configuration files for each project or you can optionally provide a customized template as a path or URL which falls back to project's `cliff.toml` if it exist.

Additionally, it utilizes the `cliff-template.toml` and dynamically replaces values via [Github context object](https://docs.github.com/en/actions/learn-github-actions/contexts) and runs the [git-cliff-action](https://github.com/orhun/git-cliff-action) using a generated `cliff.toml`.

```yml
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Run git-cliff
uses: tj-actions/git-cliff@v1
```

## GitLab CI/CD

It is possible to generate changelogs using [GitLab CI/CD](https://docs.gitlab.com/ee/ci/).
Expand Down

0 comments on commit 2520dd2

Please sign in to comment.