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

docs: Update README

releases/v3
Tycho Bokdam 2020-04-16 10:28:28 +02:00
parent 913b3473c4
commit c26b34b607
No known key found for this signature in database
GPG Key ID: A0FAE77C8CDF33C7
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -9,13 +9,22 @@ This action will bump version, tag commit and generate a changelog with conventi
- **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`.
- **Optional** `changelog-release-count`: Number of releases to preserve in changelog. Default `5`, use `0` to regenerate all. - **Optional** `release-count`: Number of releases to preserve in changelog. Default `5`, use `0` to regenerate all.
## Example usage ## Example usages
Uses all the defaults
```yaml ```yaml
- name: Conventional Changelog Action - name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v1.2.0 uses: TriPSs/conventional-changelog-action@v2.0.1
with:
github-token: ${{ secrets.github_token }}
```
Overwrite everything
```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v2.0.1
with: with:
github-token: ${{ secrets.github_token }} github-token: ${{ secrets.github_token }}
git-message: 'chore(release): {version}' git-message: 'chore(release): {version}'