Skip to content

Commit

Permalink
docs(readme): split actions into different sections
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Mar 6, 2022
1 parent 70276c8 commit 99ad482
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@
- [Command Line Arguments](#command-line-arguments)
- [Examples](#examples)
- [Docker](#docker)
- [GitHub Action](#github-action)
- [GitHub Actions](#github-actions)
- [git-cliff-action](#git-cliff-action)
- [setup-git-cliff](#setup-git-cliff)
- [GitLab CI/CD](#gitlab-cicd)
- [Configuration File](#configuration-file)
- [changelog](#changelog)
Expand All @@ -67,6 +69,7 @@
- [ignore_tags](#ignore_tags)
- [date_order](#date_order)
- [sort_commits](#sort_commits)
- [link_parsers](#link_parsers)
- [Templating](#templating)
- [Context](#context)
- [Conventional Commits](#conventional-commits)
Expand Down Expand Up @@ -289,7 +292,9 @@ docker run -t -v "$(pwd)/.git":/app/ docker.pkg.github.com/orhun/git-cliff/git-c

Also, you can build the image yourself using `docker build -t git-cliff .` command.

## GitHub Action
## GitHub Actions

### git-cliff-action

It is possible to generate changelogs using [GitHub Actions](https://docs.github.com/en/actions) via [git-cliff-action](https://github.com/orhun/git-cliff-action).

Expand All @@ -307,8 +312,11 @@ See the [repository](https://github.com/orhun/git-cliff-action) for other [examp
Also, see the [continuous deployment workflow](./.github/workflows/cd.yml) of this project which sets the release notes for GitHub releases using this action.
There is another option of GitHub Actions: [setup-git-cliff](https://github.com/kenji-miyake/setup-git-cliff).
While `git-cliff-action` uses the Docker image generated by [docker.yml](https://github.com/orhun/git-cliff/blob/main/.github/workflows/docker.yml), `setup-git-cliff` installs the binary executable in the [release artifacts](https://github.com/orhun/git-cliff/releases/latest).
### setup-git-cliff
There is also another GitHub Action which is [setup-git-cliff](https://github.com/kenji-miyake/setup-git-cliff).
While `git-cliff-action` uses the Docker image generated by [docker.yml](https://github.com/orhun/git-cliff/blob/main/.github/workflows/docker.yml), `setup-git-cliff` installs the binary executable in the [release artifacts](https://github.com/orhun/git-cliff/releases/latest):

```yml
- name: Check out repository
Expand Down

0 comments on commit 99ad482

Please sign in to comment.