mirror of
https://github.com/orhun/git-cliff.git
synced 2024-12-14 14:15:23 +03:00
docs(readme): add GitLab CI/CD section to README.md (#24)
Co-authored-by: Arthur Dion <dion@eurecom.fr>
This commit is contained in:
parent
f447cc2e73
commit
90a87c5874
25
README.md
25
README.md
@ -50,6 +50,7 @@
|
|||||||
- [Examples](#examples)
|
- [Examples](#examples)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
- [GitHub Action](#github-action)
|
- [GitHub Action](#github-action)
|
||||||
|
- [GitLab CI/CD](#gitlab-ci)
|
||||||
- [Configuration File](#configuration-file)
|
- [Configuration File](#configuration-file)
|
||||||
- [changelog](#changelog)
|
- [changelog](#changelog)
|
||||||
- [header](#header)
|
- [header](#header)
|
||||||
@ -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.
|
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
|
## Configuration File
|
||||||
|
|
||||||
**git-cliff** configuration file supports [TOML](https://github.com/toml-lang/toml) (preferred) and [YAML](https://yaml.org) formats.
|
**git-cliff** configuration file supports [TOML](https://github.com/toml-lang/toml) (preferred) and [YAML](https://yaml.org) formats.
|
||||||
|
Loading…
Reference in New Issue
Block a user