improve ReleaseNeededPlugin javadoc
@@ -13,6 +13,15 @@ import org.shipkit.internal.gradle.util.TaskMaker;
/**
* Adds tasks for checking if release is needed.
+ * <br>
+ * If the build is executed on a releasable branch the following criteria are checked:
+ * <ul>
+ * <li>SKIP_RELEASE env variable: no release if this environment variable is available</li>
+ * <li>[ci skip-release] commit message: no release if this commit message is available</li>
+ * <li>PR build: no release if the build job is a pull request build</li>
+ * <li>[ci skip-compare-publications] commit message: release if this commit message is available (although the previous and the current release might be identical)</li>
+ * <li>compare publications: release if previous publication is not identical to the current publication</li>
+ * </ul>
*
* Applies following plugins and preconfigures tasks provided by those plugins:
*
