| configurationJson | Defines the configuration json. If provided, will be prefered over `configuration`. | — | — |
| configuration | Defines the relative path to the configuration file. | — | — |
| path | Defines the directory the repo is located in (checkout directory) | — | — |
| owner | Defines the owner of the repository to create the changelog for | — | — |
| repo | Defines the repository to create the changelog for | — | — |
| fromTag | Defines the previous tag to compare against | — | — |
| toTag | Defines the newly tag created | — | — |
| includeOpen | Defines if the changelog should include open PRs | — | false |
| ignorePreReleases | Defines if the action will only use full releases to compare against (Only used if fromTag is not defined). E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick | — | false |
| failOnError | Defines if the action should result in a build failure, if an error was discovered | — | false |
| fetchViaCommits | Defines if PRs are fetched via the commits identified. This will do 1 API request per commit -> Best for scenarios with squash merges | Or shorter from-to diffs (< 10 commits) | Also effective for shorters diffs for very old PRs | — | false |
| fetchReviewers | Will enable fetching the users/reviewers who approved the PR | — | false |
| fetchReleaseInformation | Will enable fetching release information for the tags. E.g. creation date | — | false |
| fetchReviews | Will enable fetching the reviews (comments) attached to the PR | — | false |
| mode | Defines the mode used to retrieve the information. Available options: [`PR`, `COMMIT`, `HYBRID`]. Defaults to `PR`. | — | — |
| commitMode | [Deprecated] Enables the commit based mode. This mode generates changelogs based on the commits. Please note that this lacks a lot of features only possible with PRs. | — | false |
| outputFile | If defined, the changelog will get written to this file. (relative to the checkout dir) | — | — |
| token | Defines the token to use to execute the git API requests with, uses `env.GITHUB_TOKEN` by default | — | ${{ github.token }} |
| baseUrl | Defines the base url for GitHub Enterprise authentication, uses `https://api.github.com` by default | — | — |
| exportCache | If enabled, the action will export the collected data to the cache. This is disabled by default. Can be passed to a follow up run via `cache`. | — | false |
| exportOnly | If enabled, the action will only collect the data and terminate afterwards. Data can then be consumed by steps afterwards. This requires `exportCache` to be enabled | — | false |
| cache | Provide the cache of a previous run. Allows to re-use collected information multiple times to generate different release notes. Requires `exportCache` to be enabled for the previous run. | — | — |
| platform | Defines the platform the action is run on. Available options: [`github`, `gitea`]. Defaults to `github`. | — | github |