Skip to content

Commit

Permalink
docs(readme): add GitLab CI/CD section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Arthur Dion committed Oct 19, 2021
1 parent f447cc2 commit fddb2fd
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
- [Examples](#examples)
- [Docker](#docker)
- [GitHub Action](#github-action)
- [GitLab CI/CD](#gitlab-ci)
- [Configuration File](#configuration-file)
- [changelog](#changelog)
- [header](#header)
Expand Down Expand Up @@ -273,6 +274,30 @@ 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.
## GitLab CI/CD
It is possible to generate changelogs using [GitLab CI/CD](https://docs.gitlab.com/ee/ci/).
This minimal example creates artifacts that can be use on another job.
```yml
- changelog:
image:
name: orhunp/git-cliff:latest
entrypoint: [""]
variables:
GIT_STRATEGY: clone # clone entire repo instead of reusing workspace
GIT_DEPTH: 0 # avoid shallow clone to give cliff all the info it needs
stage: doc
script:
- git-cliff -r . > CHANGELOG.md
artifacts:
paths:
- CHANGELOG.md
```
Please note that the stage is `doc` and has to be changed accordingly to your need.

## Configuration File

**git-cliff** configuration file supports [TOML](https://github.com/toml-lang/toml) (preferred) and [YAML](https://yaml.org) formats.
Expand Down

0 comments on commit fddb2fd

Please sign in to comment.