diff --git a/README.md b/README.md index 248c692..a2b951c 100644 --- a/README.md +++ b/README.md @@ -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** `tag-prefix`: Prefix for the git tags. Default `v`. - **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 - 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: github-token: ${{ secrets.github_token }} git-message: 'chore(release): {version}'