| platform | Defines the platform the action is run on. Available options: [`github`, `gitea`, `local`, `git`]. Defaults to auto-detection from environment. | no | — |
| token | Defines the token to use to execute the git API requests with, uses environment token by default | no | — |
| repo | Defines the repository to create the changelog for (owner/repo or URL). Defaults to the current repository if not provided. | no | — |
| from-tag | Defines the previous tag to compare against. Supports special values:
- `@latest-release`: resolves to the tag of the most recent published release
(falls back to the previous tag with a warning on local git or if no release exists,
or if the release tag is the same as to-tag).
- `-N` (e.g. `-1`, `-2`): selects the tag N positions before to-tag in newest-first
history (e.g. `-1` is equivalent to the default auto-detect behaviour).
| no | — |
| to-tag | Defines the new tag to compare to. Defaults to `@current`.
- `@current` (default): use the tag the workflow is running under (from the git ref),
or fall back to the most recent tag if not running on a tag event.
| no | @current |
| mode | Defines the mode used to retrieve the information. Available options: [`PR`, `COMMIT`, `HYBRID`]. Defaults to `PR`. | no | PR |
| configuration | Defines the relative path to the configuration file. | no | — |
| configuration-json | Defines the configuration json. If provided, will be preferred over `configuration`. | no | — |
| ignore-pre-releases | Defines if the action will only use full releases to compare against (Only used if fromTag is not defined). | no | false |
| fetch-tag-annotations | Defines if the action should fetch tag annotation messages | no | false |
| prefix-message | Optional message to prepend to the generated changelog | no | — |
| postfix-message | Optional message to append to the generated changelog | no | — |
| include-open | Defines if the changelog should include open PRs | no | false |
| fail-on-error | Defines if the action should result in a build failure, if an error was discovered | no | false |
| verbose | Enable verbose debug logging. Also enabled when ACTIONS_STEP_DEBUG=true. | no | false |
| skip-certificate-check | Skip TLS certificate verification for API calls (self-hosted instances). | no | false |
| max-tags-to-fetch | Maximum number of tags to fetch when searching for tags. If a specified tag is not found in the initial batch, more tags will be fetched up to this limit. Defaults to 1000. | no | 1000 |