From 022ac9ae3cd8dc13cab68201f0f2b5a53642ff2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Konrad=20H=C3=B6ffner?= Date: Tue, 6 Aug 2024 10:20:52 +0200 Subject: [PATCH] document commitMode to mode transition in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c57ca10..c56d880 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ jobs: - name: Build Changelog uses: mikepenz/release-changelog-builder-action@v5 with: - commitMode: true + mode: "COMMIT" configurationJson: | { "template": "#{{CHANGELOG}}", @@ -225,7 +225,7 @@ Depending on the use-case additional settings can be provided to the action | `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 | -| `commitMode` | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. 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. Note: the commit or hybrid modes are not fully supported. 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"`. | | `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. |