diff --git a/README.md b/README.md index 8e1fce3..00ada0d 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,7 @@ Full action configuration: uses: maven-flow/merge@v1 with: changelog-file: '**/CHANGELOG.md' + changelog-rebase: false pom-file: '**/pom.xml' source-branch: ${{ github.ref_name }} target-branch: 'develop' @@ -122,6 +123,12 @@ jobs: **Default value:** `**/CHANGELOG.md` +### `changelog-rebase` + +**Optional.** Whether or not the changelog merge driver should run in [rebase mode](https://github.com/maven-flow/changelog-merge-driver/tree/main?tab=readme-ov-file#how-it-works-rebase-mode). Recommended setting is `false` for merging feature branches into `develop`, and `true` when updating feature branches with latest changes from `develop`. + +**Default value:** `false` + ### `pom-file` **Optional.** The name of your Maven project files. It may contain wildcard characters - the same format as in `.gitignore` or `.gitattributes` files. In multi-module Maven projects it is recommended to use wildcards to match project files of the parent project and all of it's sub-modules.