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:50 +02:00 committed by GitHub
parent 80757c3a5c
commit 10ec8cd474
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,11 +4,11 @@ This action will bump version, tag commit and generate a changelog with conventi
## Inputs ## Inputs
-**Required** `github-token`: Github token. - **Required** `github-token`: Github token.
-**Optional** `git-message`: Commit message that is used when committing the changelog. - **Optional** `git-message`: Commit message that is used when committing the changelog.
-**Optional** `preset`: Preset that is used from conventional commits. Default `angular`. - **Optional** `preset`: Preset that is used from conventional commits. Default `angular`.
-**Optional** `tag-prefix`: Prefix for the git tags. Default `v`. - **Optional** `tag-prefix`: Prefix for the git tags. Default `v`.
-**Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`. - **Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`.
## Example usage ## Example usage