mirror of
https://github.com/orhun/git-cliff-action.git
synced 2026-03-22 07:25:43 +08:00
docs(readme): add description for the example
This commit is contained in:
20
README.md
20
README.md
@@ -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
|
||||
|
||||
### Inputs
|
||||
### Input variables
|
||||
|
||||
- `config`: Path of the configuration file. Default: `"cliff.toml"`
|
||||
- `args`: Arguments to pass to git-cliff. Default: `"-v"`
|
||||
- `config`: Path of the configuration file. (Default: `"cliff.toml"`)
|
||||
- `args`: Arguments to pass to git-cliff. (Default: `"-v"`)
|
||||
|
||||
### Outputs
|
||||
### Output variables
|
||||
|
||||
- `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
|
||||
|
||||
The following example fetches the whole Git history (`fetch-depth: 0`), generates a changelog in `./CHANGELOG.md`, and prints it out.
|
||||
|
||||
```yml
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Generate a changelog
|
||||
uses: orhun/git-cliff-action@v1
|
||||
id: git-cliff
|
||||
@@ -32,6 +35,7 @@ This action generates a changelog based on your Git history using [git-cliff](ht
|
||||
args: --verbose
|
||||
env:
|
||||
OUTPUT: CHANGELOG.md
|
||||
|
||||
- name: Print the changelog
|
||||
run: cat "${{ steps.git-cliff.outputs.changelog }}"
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user