orhun/git-cliff-action
1
0
Fork 0
mirror of https://github.com/orhun/git-cliff-action.git synced 2026-03-22 15:35:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): add description for the example

Browse Source
This commit is contained in:
orhun
2021-06-19 20:02:25 +03:00
parent 4b8f53d10e
commit 1c922ae044
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -1,29 +1,32 @@
# git-cliff changelog generator action # git-cliff action
This action generates a changelog based on your Git history using [git-cliff](https://github.com/orhun/git-cliff), on the fly! This action generates a changelog based on your Git history using [git-cliff](https://github.com/orhun/git-cliff) on the fly!
## Usage ## Usage
### Inputs ### Input variables
- `config`: Path of the configuration file. Default: `"cliff.toml"` - `config`: Path of the configuration file. (Default: `"cliff.toml"`)
- `args`: Arguments to pass to git-cliff. Default: `"-v"` - `args`: Arguments to pass to git-cliff. (Default: `"-v"`)
### Outputs ### Output variables
- `changelog`: Output file that contains the generated changelog. - `changelog`: Output file that contains the generated changelog.
### Environment ### Environment variables
- `OUTPUT`: Output file. Default: `"git-cliff/CHANGELOG.md"` - `OUTPUT`: Output file. (Default: `"git-cliff/CHANGELOG.md"`)
### Examples ### Examples
The following example fetches the whole Git history (`fetch-depth: 0`), generates a changelog in `./CHANGELOG.md`, and prints it out.
```yml ```yml
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v2
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Generate a changelog - name: Generate a changelog
uses: orhun/git-cliff-action@v1 uses: orhun/git-cliff-action@v1
id: git-cliff id: git-cliff
@@ -32,6 +35,7 @@ This action generates a changelog based on your Git history using [git-cliff](ht
args: --verbose args: --verbose
env: env:
OUTPUT: CHANGELOG.md OUTPUT: CHANGELOG.md
- name: Print the changelog - name: Print the changelog
run: cat "${{ steps.git-cliff.outputs.changelog }}" run: cat "${{ steps.git-cliff.outputs.changelog }}"
``` ```