Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): add tj-actions/git-cliff to the list of actions #152

Merged
merged 1 commit into from
Apr 9, 2023
Merged

docs(readme): add tj-actions/git-cliff to the list of actions #152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
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