Package com.cloudbees.jenkins

Class GitHubCommitNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

com.cloudbees.jenkins.GitHubCommitNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class GitHubCommitNotifier
extends Notifier
implements SimpleBuildStep

Create commit status notifications on the commits based on the outcome of the build.

Author:

Nicolas De Loof

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubCommitNotifier.DescriptorImpl

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
GitHubCommitNotifier()
GitHubCommitNotifier(String resultOnFailure)

Method Summary

Modifier and Type	Method	Description
static Result	getDefaultResultOnFailure()
BuildStepMonitor	getRequiredMonitorService()
String	getResultOnFailure()
ExpandableMessage	getStatusMessage()
void	perform(Run<?,?> build, FilePath ws, Launcher launcher, TaskListener listener)
void	setStatusMessage(ExpandableMessage statusMessage)

Methods inherited from class hudson.tasks.Notifier

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 Details

GitHubCommitNotifier

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public GitHubCommitNotifier()

GitHubCommitNotifier

@DataBoundConstructor
public GitHubCommitNotifier(String resultOnFailure)

Since:

1.10

Method Details

getStatusMessage

public ExpandableMessage getStatusMessage()

Since:

1.14.1

setStatusMessage

@DataBoundSetter
public void setStatusMessage(ExpandableMessage statusMessage)

Since:

1.14.1

getResultOnFailure

@NonNull
public String getResultOnFailure()

Since:

1.10

getDefaultResultOnFailure

@NonNull
public static Result getDefaultResultOnFailure()

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

perform

public void perform(@NonNull
 Run<?,?> build,
 @NonNull
 FilePath ws,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException