Skip to content

Commit

Permalink
Documented attribute changelog-rebase.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jardo-51 committed Jul 13, 2024
1 parent 5f74308 commit 03547fc
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 03547fc

Please sign in to comment.