See also "How Shipkit Works" documentation index. Please help us with docs and submit a PR with improvements!
Releasing every time we have a change in the project may lead to quite
a lot of releases. It would be better to release only when the change is
interesting from the customer perspective. How to achieve that? Shipkit
provides you with releaseNeeded task that you can run to find out
if the release is needed.
Implementations of ReleaseNeededTask allow you to configure following properties:
- releasableBranchRegex is used to determine if we should release on this branch or not. For example we don't want to release on tags and feature branches. This parameter is a regular Java regex, and defaults to "master|release/.+".
- pullRequest is set to true if the build is done for pull request. It is automatically set by Shipkit CI plugins, eg. TravisPlugin.
- commitMessage is the message of commit for which build is run. Also set automatically by Shipkit CI plugins.
- branch is a current Git branch. Also set by Shipkit CI Plugins.
Release is considered not needed when:
- 'SKIP_RELEASE' environment variable is present
- commit message contains '[ci skip-release]'
- we are building a "pull request", see Travis Documentation for more information
Release is needed when all above is false and:
- we are building on a branch that matches releasableBranchRegex (e.g. 'master'), see releasableBranchRegex in Configuration section
- and one of the following criteria is true:
- there are changes in the binaries when compared to previous version
- commit message contains '[ci skip-compare-publications]'
- 'skipComparePublications' property on task releaseNeeded is true
You usually don't need to apply this plugin. It comes with ShipkitJavaPlugin or ShipkitGradlePlugin. Also releaseNeeded is a part of ciPerformRelease task.
To test it - run in the command line:
./gradlew releaseNeeded
or
./gradlew releaseNeeded
Thank you for reading! Questions or feedback? Start discussion by opening a ticket in GitHub!