Skip to content

Commit 027fb31

Browse files
committed
Describe how to manually add gitflow config to .git/config
1 parent c70a9d8 commit 027fb31

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.asciidoc

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,31 @@ gitflow {
182182
[[gitflow-plugins]]
183183
=== Gitflow plugins for Git
184184

185-
This plugin supports the following http://nvie.com/posts/a-successful-git-branching-model/[Gitflow] plugins:
185+
This plugin supports the following http://nvie.com/posts/a-successful-git-branching-model/[Gitflow] plugins for http://git-scm.com/[Git]:
186186

187187
* https://github.com/nvie/gitflow[git-flow]
188188
* https://github.com/petervanderdoes/gitflow[git-flow (AVH Edition)]
189189

190+
If you do not use one of the mentioned plugins *and* differ from the default names mentioned in <<branch-identifier-mapping>>, you will have to manually set the branch names and prefixes of the http://nvie.com/posts/a-successful-git-branching-model/[Gitflow] branches and prefixes in `.git/config` like these plugins would do.
191+
This is the only way for _gradle-gitflow_ to pick up this configuration.
192+
193+
The following example shows the default configuration of the above plugins:
194+
195+
----
196+
[gitflow "branch"]
197+
master = master
198+
develop = develop
199+
[gitflow "prefix"]
200+
feature = feature/
201+
release = release/
202+
hotfix = hotfix/
203+
support = support/
204+
versiontag =
205+
----
206+
207+
WARNING: Keep in mind that most *CI* servers simply clone your repository after being called by a commit hook when you push your code.
208+
Therefore `.git/config` on these servers does not contain the http://nvie.com/posts/a-successful-git-branching-model/[Gitflow] configuration that _gradle-gitflow_ needs.
209+
190210

191211
[[additional-functionality]]
192212
=== Additional functionality of the version object

0 commit comments

Comments
 (0)