Skip to content

Commit 6e6036d

Browse files
committed
Document strategy package
1 parent ee0c0c9 commit 6e6036d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* Provides the strategies for inferring the version of the project to which the plugin is applied.
3+
*
4+
* <p>
5+
* The entry point to this package is the interface {@link Strategy}.
6+
* </p>
7+
*
8+
* <p>
9+
* There is exactly one class for each type of branch defined in the <em>Gitflow Branching Model</em> that
10+
* provides a strategy to infer the version of the project.
11+
* Furthermore, there is {@link DetachedHeadStrategy} that applies if the current commit is a <strong>detached
12+
* head</strong>.
13+
* {@link AbstractStrategy} is the base class of these strategies and provides common logic like logging.
14+
* </p>
15+
*/
16+
package com.github.amkay.gradle.gitflow.strategy;

0 commit comments

Comments
 (0)