Package hudson.plugins.octopusdeploy

Class OctopusDeployReleaseRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.octopusdeploy.AbstractOctopusDeployRecorderPostBuildStep

hudson.plugins.octopusdeploy.OctopusDeployReleaseRecorder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, java.io.Serializable, jenkins.tasks.SimpleBuildStep

public class OctopusDeployReleaseRecorder
extends AbstractOctopusDeployRecorderPostBuildStep
implements java.io.Serializable

Creates a release and optionally deploys it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OctopusDeployReleaseRecorder.DescriptorImpl	Descriptor for OctopusDeployReleaseRecorder.

Nested classes/interfaces inherited from class hudson.plugins.octopusdeploy.AbstractOctopusDeployRecorderPostBuildStep

AbstractOctopusDeployRecorderPostBuildStep.AbstractOctopusDeployDescriptorImplPost

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from class hudson.plugins.octopusdeploy.AbstractOctopusDeployRecorderPostBuildStep

additionalArgs, cancelOnTimeout, deploymentTimeout, environment, octopusDeployServer, project, serverId, spaceId, tenant, tenantTag, toolId, variables, verboseLogging, waitForDeployment

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
OctopusDeployReleaseRecorder(java.lang.String serverId, java.lang.String toolId, java.lang.String project, java.lang.String releaseVersion, java.lang.String spaceId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getChannel()
java.lang.String	getDefaultPackageVersion()
boolean	getDeployThisRelease()
java.lang.String	getGitCommit()
java.lang.String	getGitRef()
boolean	getJenkinsUrlLinkback()
java.util.List<PackageConfiguration>	getPackageConfigs()
boolean	getReleaseNotes()
java.lang.String	getReleaseNotesFile()
java.lang.String	getReleaseNotesSource()
java.lang.String	getReleaseVersion()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
java.lang.String	getSpaceId()
boolean	isReleaseNotesSourceFile()
boolean	isReleaseNotesSourceScm()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setChannel(java.lang.String channel)
void	setDefaultPackageVersion(java.lang.String defaultPackageVersion)
void	setDeployThisRelease(boolean deployThisRelease)
void	setGitCommit(java.lang.String gitCommit)
void	setGitRef(java.lang.String gitRef)
void	setJenkinsUrlLinkback(boolean jenkinsUrlLinkback)
void	setPackageConfigs(java.util.List<PackageConfiguration> packageConfigs)
void	setReleaseNotes(boolean releaseNotes)
void	setReleaseNotesFile(java.lang.String releaseNotesFile)
void	setReleaseNotesSource(java.lang.String releaseNotesSource)
void	setSpaceId(java.lang.String spaceId)

Methods inherited from class hudson.plugins.octopusdeploy.AbstractOctopusDeployRecorderPostBuildStep

getAdditionalArgs, getApi, getCancelOnTimeout, getDefaultOctopusDeployServer, getDeploymentTimeout, getEnvironment, getExceptionMessage, getOctopusDeployServer, getOctopusDeployServer, getOctopusDeployServers, getOctopusDeployServersIds, getOctopusToolIds, getOctopusToolInstallations, getOctopusToolPath, getProject, getServerId, getTenant, getTenantTag, getToolId, getVariables, getVerboseLogging, getWaitForDeployment, hasAdvancedOptions, hasSpaces, launchOcto, setAdditionalArgs, setCancelOnTimeout, setDeploymentTimeout, setEnvironment, setTenant, setTenantTag, setVariables, setVerboseLogging, setWaitForDeployment

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Detail

OctopusDeployReleaseRecorder

@DataBoundConstructor
public OctopusDeployReleaseRecorder(java.lang.String serverId,
                                    java.lang.String toolId,
                                    java.lang.String project,
                                    java.lang.String releaseVersion,
                                    java.lang.String spaceId)

Method Detail

getReleaseVersion

public java.lang.String getReleaseVersion()

getReleaseNotes

public boolean getReleaseNotes()

setReleaseNotes

@DataBoundSetter
public void setReleaseNotes(boolean releaseNotes)

getReleaseNotesSource

public java.lang.String getReleaseNotesSource()

isReleaseNotesSourceFile

public boolean isReleaseNotesSourceFile()

isReleaseNotesSourceScm

public boolean isReleaseNotesSourceScm()

getChannel

public java.lang.String getChannel()

getJenkinsUrlLinkback

public boolean getJenkinsUrlLinkback()

setJenkinsUrlLinkback

@DataBoundSetter
public void setJenkinsUrlLinkback(boolean jenkinsUrlLinkback)

getReleaseNotesFile

public java.lang.String getReleaseNotesFile()

setReleaseNotesFile

@DataBoundSetter
public void setReleaseNotesFile(java.lang.String releaseNotesFile)

getDeployThisRelease

@Exported
public boolean getDeployThisRelease()

getPackageConfigs

@Exported
public java.util.List<PackageConfiguration> getPackageConfigs()

getDefaultPackageVersion

@Exported
public java.lang.String getDefaultPackageVersion()

setDefaultPackageVersion

@DataBoundSetter
public void setDefaultPackageVersion(java.lang.String defaultPackageVersion)

getGitRef

@Exported
public java.lang.String getGitRef()

setGitRef

@DataBoundSetter
public void setGitRef(java.lang.String gitRef)

getGitCommit

@Exported
public java.lang.String getGitCommit()

setGitCommit

@DataBoundSetter
public void setGitCommit(java.lang.String gitCommit)

setReleaseNotesSource

@DataBoundSetter
public void setReleaseNotesSource(java.lang.String releaseNotesSource)

setPackageConfigs

@DataBoundSetter
public void setPackageConfigs(java.util.List<PackageConfiguration> packageConfigs)

setSpaceId

@DataBoundSetter
public void setSpaceId(java.lang.String spaceId)

getSpaceId

public java.lang.String getSpaceId()

Overrides:

getSpaceId in class AbstractOctopusDeployRecorderPostBuildStep

setChannel

@DataBoundSetter
public void setChannel(java.lang.String channel)

setDeployThisRelease

@DataBoundSetter
public void setDeployThisRelease(boolean deployThisRelease)

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

Overrides:

getRequiredMonitorService in class AbstractOctopusDeployRecorderPostBuildStep

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> run,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws hudson.AbortException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

hudson.AbortException