- introduce new placeholder for AUTHOR_NAME
- FIX https://github.com/mikepenz/release-changelog-builder-action/issues/1360
This commit is contained in:
Mike Penz
@@ -206,29 +206,29 @@ Depending on the use-case additional settings can be provided to the action
|
||||
> [!NOTE]
|
||||
> All input values are optional. It is only required to provide the `token` either via the input, or as `env` variable.
|
||||
|
||||
| **Input** | **Description** |
|
||||
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `configurationJson` | Provide the configuration directly via the build `yml` file. Please note that `${{}}` has to be written as `#{{}}` within the `yml` file. |
|
||||
| `configuration` | Relative path, to the `configuration.json` file, providing additional configurations |
|
||||
| `outputFile` | Optional relative path to a file to store the resulting changelog in. |
|
||||
| `owner` | The owner of the repository to generate the changelog for |
|
||||
| `repo` | Name of the repository we want to process |
|
||||
| `fromTag` | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) |
|
||||
| `toTag` | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) |
|
||||
| `path` | Allows to specify an alternative sub directory, to use as base |
|
||||
| `token` | Alternative config to specify token. You should prefer `env.GITHUB_TOKEN` instead though |
|
||||
| `baseUrl` | Alternative config to specify base url for GitHub Enterprise authentication. Default value set to `https://api.github.com` |
|
||||
| `includeOpen` | Enables to also fetch currently open PRs. Default: false |
|
||||
| `ignorePreReleases` | Allows to ignore pre-releases for changelog generation (E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick). Only used if `fromTag` was not specified. Default: false |
|
||||
| `failOnError` | Defines if the action will result in a build failure if problems occurred. Default: false |
|
||||
| `fetchViaCommits` | Enables PRs to get fetched via the commits identified between from->to tag. 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. Default: false |
|
||||
| `fetchReviewers` | Will enable fetching the users/reviewers who approved the PR. Default: false |
|
||||
| `fetchReleaseInformation` | Will enable fetching additional release information from tags. Default: false |
|
||||
| `fetchReviews` | Will enable fetching the reviews on of the PR. Default: false |
|
||||
| `mode` | Defines the mode used to retrieve the information. Available options: [`PR`, `COMMIT`, `HYBRID`]. Defaults to `PR`. Hybrid mode treats commits like pull requests. Commit mode is a special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. Formerly set as `commitMode: true`, this setting is now deprecated and should be converted to `mode: "COMMIT"`. Note: the commit or hybrid modes are not fully supported. |
|
||||
| `exportCache` | Will enable exporting the fetched PR information to a cache, which can be re-used by later runs. Default: false |
|
||||
| `exportOnly` | When enabled, will result in only exporting the cache, without generating a changelog. Default: false (Requires `exportCache` to be enabled) |
|
||||
| `cache` | The file path to write/read the cache to/from. |
|
||||
| **Input** | **Description** |
|
||||
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `configurationJson` | Provide the configuration directly via the build `yml` file. Please note that `${{}}` has to be written as `#{{}}` within the `yml` file. |
|
||||
| `configuration` | Relative path, to the `configuration.json` file, providing additional configurations |
|
||||
| `outputFile` | Optional relative path to a file to store the resulting changelog in. |
|
||||
| `owner` | The owner of the repository to generate the changelog for |
|
||||
| `repo` | Name of the repository we want to process |
|
||||
| `fromTag` | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) |
|
||||
| `toTag` | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) |
|
||||
| `path` | Allows to specify an alternative sub directory, to use as base |
|
||||
| `token` | Alternative config to specify token. You should prefer `env.GITHUB_TOKEN` instead though |
|
||||
| `baseUrl` | Alternative config to specify base url for GitHub Enterprise authentication. Default value set to `https://api.github.com` |
|
||||
| `includeOpen` | Enables to also fetch currently open PRs. Default: false |
|
||||
| `ignorePreReleases` | Allows to ignore pre-releases for changelog generation (E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick). Only used if `fromTag` was not specified. Default: false |
|
||||
| `failOnError` | Defines if the action will result in a build failure if problems occurred. Default: false |
|
||||
| `fetchViaCommits` | Enables PRs to get fetched via the commits identified between from->to tag. 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. Default: false |
|
||||
| `fetchReviewers` | Will enable fetching the users/reviewers who approved the PR. Default: false |
|
||||
| `fetchReleaseInformation` | Will enable fetching additional release information from tags. Default: false |
|
||||
| `fetchReviews` | Will enable fetching the reviews on of the PR. Default: false |
|
||||
| `mode` | Defines the mode used to retrieve the information. Available options: [`PR`, `COMMIT`, `HYBRID`]. Defaults to `PR`. Hybrid mode treats commits like pull requests. Commit mode is a special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. Formerly set as `commitMode: true`, this setting is now deprecated and should be converted to `mode: "COMMIT"`. Note: the commit or hybrid modes are not fully supported. |
|
||||
| `exportCache` | Will enable exporting the fetched PR information to a cache, which can be re-used by later runs. Default: false |
|
||||
| `exportOnly` | When enabled, will result in only exporting the cache, without generating a changelog. Default: false (Requires `exportCache` to be enabled) |
|
||||
| `cache` | The file path to write/read the cache to/from. |
|
||||
|
||||
> [!WARNING]
|
||||
> `${{ secrets.GITHUB_TOKEN }}` only grants rights to the current repository, for other repositories please use a PAT (Personal Access Token).
|
||||
@@ -466,22 +466,23 @@ Table of supported placeholders allowed to be used in the `template` and `empty_
|
||||
|
||||
Table of supported placeholders allowed to be used in the `pr_template` configuration, which will be included in the release notes / changelog.
|
||||
|
||||
| **Placeholder** | **Description** |
|
||||
|-------------------|----------------------------------------------------------------------------------------------------|
|
||||
| `#{{NUMBER}}` | The number referencing this pull request. E.g. 13. |
|
||||
| `#{{TITLE}}` | Specified title of the merged pull request. |
|
||||
| `#{{URL}}` | Url linking to the pull request on GitHub. |
|
||||
| `#{{STATUS}}` | Status of the PR. Usually always `merged`. Possibly `Open` if `includeOpen` is configured. |
|
||||
| `#{{CREATED_AT}}` | The ISO time, the pull request was created at. |
|
||||
| `#{{MERGED_AT}}` | The ISO time, the pull request was merged at. |
|
||||
| `#{{MERGE_SHA}}` | The commit SHA, the pull request was merged with. |
|
||||
| `#{{AUTHOR}}` | Author creating and opening the pull request. |
|
||||
| `#{{LABELS}}` | The labels associated with this pull request, joined by `,`. |
|
||||
| `#{{MILESTONE}}` | Milestone this PR was part of, as assigned on GitHub. |
|
||||
| `#{{BODY}}` | Description/Body of the pull request as specified on GitHub. |
|
||||
| `#{{ASSIGNEES}}` | Login names of assigned GitHub users, joined by `,`. |
|
||||
| `#{{REVIEWERS}}` | GitHub Login names of specified reviewers, joined by `,`. Requires `fetchReviewers` to be enabled. |
|
||||
| `#{{APPROVERS}}` | GitHub Login names of users who approved the PR, joined by `,`. |
|
||||
| **Placeholder** | **Description** |
|
||||
|--------------------|----------------------------------------------------------------------------------------------------|
|
||||
| `#{{NUMBER}}` | The number referencing this pull request. E.g. 13. |
|
||||
| `#{{TITLE}}` | Specified title of the merged pull request. |
|
||||
| `#{{URL}}` | Url linking to the pull request on GitHub. |
|
||||
| `#{{STATUS}}` | Status of the PR. Usually always `merged`. Possibly `Open` if `includeOpen` is configured. |
|
||||
| `#{{CREATED_AT}}` | The ISO time, the pull request was created at. |
|
||||
| `#{{MERGED_AT}}` | The ISO time, the pull request was merged at. |
|
||||
| `#{{MERGE_SHA}}` | The commit SHA, the pull request was merged with. |
|
||||
| `#{{AUTHOR}}` | Author creating and opening the pull request. |
|
||||
| `#{{AUTHOR_NAME}}` | The name of the Author creating and opening the pull request (Can be empty). |
|
||||
| `#{{LABELS}}` | The labels associated with this pull request, joined by `,`. |
|
||||
| `#{{MILESTONE}}` | Milestone this PR was part of, as assigned on GitHub. |
|
||||
| `#{{BODY}}` | Description/Body of the pull request as specified on GitHub. |
|
||||
| `#{{ASSIGNEES}}` | Login names of assigned GitHub users, joined by `,`. |
|
||||
| `#{{REVIEWERS}}` | GitHub Login names of specified reviewers, joined by `,`. Requires `fetchReviewers` to be enabled. |
|
||||
| `#{{APPROVERS}}` | GitHub Login names of users who approved the PR, joined by `,`. |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> `v4` updates the default placeholders format to `#{{}}`. The old format `${{}}` will be supported until v5 for backwards compatibility.
|
||||
|
||||
Reference in New Issue
Block a user