docs(readme): update README.md about new action arguments

This commit is contained in:
orhun
2021-06-18 19:05:43 +03:00
parent 3b33c9dab6
commit c5a5d63d3c

View File

@@ -6,21 +6,34 @@ This action generates a changelog based on your Git history using [git-cliff](ht
### Inputs ### Inputs
* `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 ### Outputs
* `changelog`: The generated changelog. - `changelog`: Output file that contains the generated changelog.
### Environment
- `OUTPUT`: Output file. Default: `"git-cliff/CHANGELOG.md"`
### Examples ### Examples
``` ```yml
- name: Changelog Generator - name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Generate a changelog
uses: orhun/git-cliff-action@v1 uses: orhun/git-cliff-action@v1
id: git-cliff
with: with:
config: cliff.toml config: cliff.toml
args: --verbose args: --verbose
env:
OUTPUT: CHANGELOG.md
- name: Print the changelog
run: cat "${{ steps.git-cliff.outputs.changelog }}"
``` ```
## Credits ## Credits