Skip to content

Commit b08e155

Browse files
authored
docs: clarify that the commit override does not work on plain merges (#1917)
See #1899
1 parent 57b2b38 commit b08e155

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The above commit message will contain:
9999
that it's a breaking change.
100100
3. an entry for the feature **"update encode to support unicode"**.
101101

102-
> :warning: **Important:** The additional messages must be added to the bottom of the commit.
102+
:warning: **Important:** The additional messages must be added to the bottom of the commit.
103103

104104
## How do I change the version number?
105105

@@ -133,6 +133,10 @@ END_COMMIT_OVERRIDE
133133
The next time Release Please runs, it will use that override section as the
134134
commit message instead of the merged commit message.
135135

136+
:warning: **Important:** This feature will not work with plain merges because
137+
release-please does not know which commit(s) to apply the override to. [We
138+
recommend using squash-merge instead](#linear-git-commit-history-use-squash-merge).
139+
136140
## Release Please bot does not create a release PR. Why?
137141

138142
Release Please creates a release pull request after it notices the default branch

0 commit comments

Comments
 (0)