Action
/
conventional-changelog-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Updated README

releases/v3
Tycho Bokdam 2019-10-18 11:51:26 +02:00 committed by GitHub
parent a860a263fa
commit 80757c3a5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -4,28 +4,15 @@ This action will bump version, tag commit and generate a changelog with conventi
## Inputs
### `github-token`
**Required** Github token.
### `git-message`
**Optional** Commit message that is used when committing the changelog.
### `preset`
**Optional** Preset that is used from conventional commits. Default `angular`.
### `tag-prefix`
**Optional** Prefix for the git tags. Default `v`.
### `output-file`
**Optional** File to output the changelog to. Default `CHANGELOG.md`.
-**Required** `github-token`: Github token.
-**Optional** `git-message`: Commit message that is used when committing the changelog.
-**Optional** `preset`: Preset that is used from conventional commits. Default `angular`.
-**Optional** `tag-prefix`: Prefix for the git tags. Default `v`.
-**Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`.
## Example usage
```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v0.0.1
with:
@ -34,3 +21,5 @@ This action will bump version, tag commit and generate a changelog with conventi
preset: 'angular'
tag-prefix: 'v'
output-file: 'CHANGELOG.md'
```