Package org.jenkinsci.plugins.github.status

Class GitHubCommitStatusSetter

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

org.jenkinsci.plugins.github.status.GitHubCommitStatusSetter

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class GitHubCommitStatusSetter
extends Notifier
implements SimpleBuildStep

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

Since:

1.19.0

Author:

lanwen (Merkushev Kirill)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubCommitStatusSetter.GitHubCommitStatusSetterDescr

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
GitHubCommitStatusSetter()

Method Summary

Modifier and Type	Method	Description
GitHubCommitShaSource	getCommitShaSource()
GitHubStatusContextSource	getContextSource()
List<StatusErrorHandler>	getErrorHandlers()
GitHubReposSource	getReposSource()
BuildStepMonitor	getRequiredMonitorService()
GitHubStatusBackrefSource	getStatusBackrefSource()
GitHubStatusResultSource	getStatusResultSource()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)	Gets info from the providers and updates commit status
Object	readResolve()
void	setCommitShaSource(GitHubCommitShaSource commitShaSource)
void	setContextSource(GitHubStatusContextSource contextSource)
void	setErrorHandlers(List<StatusErrorHandler> errorHandlers)
void	setReposSource(GitHubReposSource reposSource)
void	setStatusBackrefSource(GitHubStatusBackrefSource statusBackrefSource)
void	setStatusResultSource(GitHubStatusResultSource statusResultSource)

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 Detail

GitHubCommitStatusSetter

@DataBoundConstructor
public GitHubCommitStatusSetter()

Method Detail

setCommitShaSource

@DataBoundSetter
public void setCommitShaSource(GitHubCommitShaSource commitShaSource)

setReposSource

@DataBoundSetter
public void setReposSource(GitHubReposSource reposSource)

setContextSource

@DataBoundSetter
public void setContextSource(GitHubStatusContextSource contextSource)

setStatusResultSource

@DataBoundSetter
public void setStatusResultSource(GitHubStatusResultSource statusResultSource)

setStatusBackrefSource

@DataBoundSetter
public void setStatusBackrefSource(GitHubStatusBackrefSource statusBackrefSource)

setErrorHandlers

@DataBoundSetter
public void setErrorHandlers(List<StatusErrorHandler> errorHandlers)

getCommitShaSource

public GitHubCommitShaSource getCommitShaSource()

Returns:

SHA provider

getReposSource

public GitHubReposSource getReposSource()

Returns:

Repository list provider

getContextSource

public GitHubStatusContextSource getContextSource()

Returns:

Context provider

getStatusResultSource

public GitHubStatusResultSource getStatusResultSource()

Returns:

state + msg provider

getStatusBackrefSource

public GitHubStatusBackrefSource getStatusBackrefSource()

Returns:

backref provider

getErrorHandlers

public List<StatusErrorHandler> getErrorHandlers()

Returns:

error handlers

perform

public void perform(@NonNull
                    Run<?,?> run,
                    @NonNull
                    FilePath workspace,
                    @NonNull
                    Launcher launcher,
                    @NonNull
                    TaskListener listener)

Gets info from the providers and updates commit status

Specified by:

perform in interface SimpleBuildStep

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

readResolve

public Object readResolve()