Package org.marvelution.jji.marker

Class DeploymentBuildMarker

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.marvelution.jji.marker.DeploymentBuildMarker

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, Serializable, SimpleBuildStep

@Symbol("jiraDeploymentInfo")
public class DeploymentBuildMarker
extends Recorder
implements SimpleBuildStep, Serializable

Recorder/SimpleBuildStep that marks a build as a deployment to a specific environment.

In a pipeline the step is available under the jiraDeploymentInfo symbol, requiring only the environmentType:

     jiraDeploymentInfo environmentType: 'staging'
     jiraDeploymentInfo environmentId: 'app-stg-eu-west-1', environmentName: 'Staging', environmentType: 'staging'
 

The environmentId and environmentName values support environment-variable expansion, so dynamic values such as environmentType: env.TARGET_ENVIRONMENT work as expected.

Since:

3.8.0

Author:

Mark Rekveld

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeploymentBuildMarker.Descriptor

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

Publisher.DescriptorExtensionListImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
DeploymentBuildMarker(String environmentType)

Method Summary

Modifier and Type	Method	Description
String	getEnvironmentId()
String	getEnvironmentName()
String	getEnvironmentType()
BuildStepMonitor	getRequiredMonitorService()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
void	perform(Run<?,?> build, EnvVars env, TaskListener listener)
void	perform(Run<?,?> build, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)
void	setEnvironmentId(String environmentId)
void	setEnvironmentName(String environmentName)

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, 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, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, requiresWorkspace

Constructor Details

DeploymentBuildMarker

@DataBoundConstructor
public DeploymentBuildMarker(String environmentType)

Method Details

getEnvironmentId

public String getEnvironmentId()

setEnvironmentId

@DataBoundSetter
public void setEnvironmentId(String environmentId)

getEnvironmentName

public String getEnvironmentName()

setEnvironmentName

@DataBoundSetter
public void setEnvironmentName(String environmentName)

getEnvironmentType

public String getEnvironmentType()

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)
                throws InterruptedException,
IOException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

perform

public void perform(@NonNull
 Run<?,?> build,
 @Nullable
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)

Specified by:

perform in interface SimpleBuildStep

perform

public void perform(@NonNull
 Run<?,?> build,
 @NonNull
 EnvVars env,
 @NonNull
 TaskListener listener)

Specified by:

perform in interface SimpleBuildStep