| commit_with_api | Use the GitHub api to generate a signed commit. However, you cannot force push
and this will be a new commit.
| no | true |
| release_type | The semantic version change type. Accepted values are major, minor, patch | no | — |
| auto_versioning | Automatically handle the semantic versioning based on the changelog file. | no | false |
| changelog_style | Set whether you are following the standard set by keep-a-changelog, common-changelog, or a
custom changelog format. Can only be one of `keep-a-changelog`, `common-changelog`, or `custom`.
| no | keep-a-changelog |
| changelog_heading | Set a custom heading for your changelog. This can only be set if `changelog_style` is set to `custom`
| no | — |
| dir | The directory to keep your changelog files. Defaults to the `changelog` directory. | yes | build-changelog |
| flags | Any custom flags with prefixes. Ex. `[Breaking 🧨]` for breaking changes. Must use a key=value
pair comma separated list no spaces.
| no | breaking=[Breaking 🧨] |
| show_author | Reference the author in the changelog entry. | no | true |
| show_author_full_name | Show the authors name instead of the authors username. | no | false |
| name_override | If you have a naming that you want to use that is not the github username, then you can
override the github username. Must use a `key=value` pair comma separated.
| no | — |
| git_tag_prefix | The prefix for your git tags. | yes | v |
| show_git_tag_prefix | Show your git tag prefix in your versions in your changelog. | no | false |
| reference_pull_requests | Automatically reference pull requests when you merge changes in. | no | true |
| reference_sha | Automatically reference commit hashes when you merge changes in. | no | true |
| version | Set the version of the unreleased changes. | no | — |
| commit_user_name | The committer user name. Defaults to `github-actions[bot]`. | no | github-actions[bot] |
| commit_user_email | The committer email. Defaults to `41898282+github-actions[bot]@users.noreply.github.com`. | no | 41898282+github-actions[bot]@users.noreply.github.com |
| commit_author | The commit author. Defaults to the use who triggered the action. | no | ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com> |
| commit_message | The commit message. | no | Update CHANGELOG. |
| commit_options | Commit options (ex. --amend) | no | "" |
| push_options | Push options (ex. --force) | no | "" |
| skip_commit | Opt out of committing change. (Ex. You can defer the commit until a later step.) | no | false |
| token | The secret value from your GITHUB_TOKEN or another token to access the GitHub API. Defaults
to the token at `github.token`
| yes | ${{ github.token }} |