Groovy Documentation

release
[Groovy] Class BaseScmPlugin

java.lang.Object
  release.PluginHelper
      release.BaseScmPlugin
All Implemented Interfaces:
Plugin

abstract class BaseScmPlugin
extends PluginHelper

Base class for all SCM-specific plugins

Authors:
evgenyg


Method Summary
void apply(Project project)

java.lang.Object buildConventionInstance()

Retrieves convention instance to be set for this plugin.

void checkCommitNeeded()

void checkUpdateNeeded()

void commit(java.lang.String message)

java.lang.Object convention()

Convenience method for sub-classes to access their own convention instance.

void createReleaseTag(java.lang.String message)

void init()

void revert()

void setConvention()

Called by ReleasePlugin when plugin's convention needs to be set.

 
Methods inherited from class PluginHelper
capitalize, convention, exec, exec, findPropertiesFile, findProperty, getLog, promptYesOrNo, readLine, releaseConvention, setConvention, tagName, updateVersionProperty, useAutomaticVersion, warnOrThrow
 

Method Detail

apply

void apply(Project project)


buildConventionInstance

java.lang.Object buildConventionInstance()
Retrieves convention instance to be set for this plugin.
Returns:
convention instance to be set for this plugin.


checkCommitNeeded

void checkCommitNeeded()


checkUpdateNeeded

void checkUpdateNeeded()


commit

void commit(java.lang.String message)


convention

@SuppressWarnings('ConfusingMethodName')
final java.lang.Object convention()
Convenience method for sub-classes to access their own convention instance.
Returns:
this plugin convention instance.


createReleaseTag

void createReleaseTag(java.lang.String message)


init

void init()


revert

void revert()


setConvention

final void setConvention()
Called by ReleasePlugin when plugin's convention needs to be set.


 

Groovy Documentation