yakworks.gradle.shipkit.versionupgrade

Class UpgradeDependencyPlugin

java.lang.Object

yakworks.gradle.shipkit.versionupgrade.UpgradeDependencyPlugin

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.Project>

public class UpgradeDependencyPlugin
extends java.lang.Object
implements org.gradle.api.Plugin<org.gradle.api.Project>

BEWARE! This plugin is in incubating state, so its API may change in the future! The plugin applies following plugins:

• ShipkitConfigurationPlugin
• GitOriginPlugin
• GitConfigPlugin

and adds following tasks:

• checkoutBaseBranch - checkouts base branch - the branch to which version upgrade should be applied through pull request
• pullUpstream - syncs the fork on which we perform version upgrade with the upstream repo
• findOpenPullRequest - finds an open pull request with version upgrade if it exists
• checkoutVersionBranch - checkouts version branch where version will be upgraded. A new branch or the head branch for open pull request
• replaceVersion - replaces version in build file, using dependency pattern
• commitVersionUpgrade - commits replaced version
• pushVersionUpgrade - pushes the commit to the version branch
• createPullRequest - creates a pull request between base and version branches if there is no open pull request for this dependency already
• mergePullRequest - wait for status checks defined for pull request and in case of success merge it to base branch. Task is executed only if there was no previously opened pull request. If createPullRequest task is skipped, mergePullRequest is also skipped and pull request needs to be merged manually. If no checks defined, pull request also needs to be merged manually
• performVersionUpgrade - task aggregating all of the above

Plugin should be used in client projects that want to have automated version upgrades of some other dependency, that use the producer version of this plugin. Project with the producer plugin applied would then clone a fork of client project and run './gradlew performVersionUpgrade -Pdependency=${group:name:version}' on it. Example of plugin usage: Configure your 'shipkit.gradle' file like here: apply plugin: 'org.shipkit.upgrade-dependency' upgradeDependency { baseBranch = 'release/2.x' buildFile = file('build.gradle') } and then call it: ./gradlew performVersionUpgrade -Pdependency=org.shipkit:shipkit:1.2.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKOUT_BASE_BRANCH
static java.lang.String	CHECKOUT_VERSION_BRANCH
static java.lang.String	COMMIT_VERSION_UPGRADE
static java.lang.String	CREATE_PULL_REQUEST
static java.lang.String	DEPENDENCY_PROJECT_PROPERTY
static java.lang.String	FIND_OPEN_PULL_REQUEST
static java.lang.String	MERGE_PULL_REQUEST
static java.lang.String	PERFORM_VERSION_UPGRADE
static java.lang.String	PULL_UPSTREAM
static java.lang.String	PUSH_VERSION_UPGRADE
static java.lang.String	REPLACE_VERSION

Constructor Summary

Constructors

Constructor and Description
UpgradeDependencyPlugin()

Method Summary

Modifier and Type	Method and Description
void	apply(org.gradle.api.Project project)
org.shipkit.internal.gradle.versionupgrade.UpgradeDependencyExtension	getUpgradeDependencyExtension()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHECKOUT_BASE_BRANCH

public static final java.lang.String CHECKOUT_BASE_BRANCH

See Also:

Constant Field Values

PULL_UPSTREAM

public static final java.lang.String PULL_UPSTREAM

See Also:

Constant Field Values

FIND_OPEN_PULL_REQUEST

public static final java.lang.String FIND_OPEN_PULL_REQUEST

See Also:

Constant Field Values

CHECKOUT_VERSION_BRANCH

public static final java.lang.String CHECKOUT_VERSION_BRANCH

See Also:

Constant Field Values

REPLACE_VERSION

public static final java.lang.String REPLACE_VERSION

See Also:

Constant Field Values

COMMIT_VERSION_UPGRADE

public static final java.lang.String COMMIT_VERSION_UPGRADE

See Also:

Constant Field Values

PUSH_VERSION_UPGRADE

public static final java.lang.String PUSH_VERSION_UPGRADE

See Also:

Constant Field Values

CREATE_PULL_REQUEST

public static final java.lang.String CREATE_PULL_REQUEST

See Also:

Constant Field Values

PERFORM_VERSION_UPGRADE

public static final java.lang.String PERFORM_VERSION_UPGRADE

See Also:

Constant Field Values

MERGE_PULL_REQUEST

public static final java.lang.String MERGE_PULL_REQUEST

See Also:

Constant Field Values

DEPENDENCY_PROJECT_PROPERTY

public static final java.lang.String DEPENDENCY_PROJECT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

UpgradeDependencyPlugin

public UpgradeDependencyPlugin()

Method Detail

apply

public void apply(org.gradle.api.Project project)

Specified by:

apply in interface org.gradle.api.Plugin<org.gradle.api.Project>

getUpgradeDependencyExtension

public org.shipkit.internal.gradle.versionupgrade.UpgradeDependencyExtension getUpgradeDependencyExtension()