org.jenkinsci.plugins.githubautostatus.notifiers

Class GithubBuildNotifier

java.lang.Object

org.jenkinsci.plugins.githubautostatus.notifiers.GithubBuildNotifier

All Implemented Interfaces:

BuildNotifier

public class GithubBuildNotifier
extends Object
implements BuildNotifier

Author:

jxpearce

Constructor Summary

Constructors

Constructor and Description
GithubBuildNotifier(org.kohsuke.github.GHRepository repository, String shaString, String targetUrl) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled() Determine whether notifier is enabled
void	notifyBuildStageStatus(String jobName, String nodeName, BuildState buildState, long nodeDuration) Send stage status notification to github
void	notifyBuildState(String jobName, String nodeName, BuildState buildState) Send stage status notification to github
void	notifyFinalBuildStatus(String jobName, BuildState buildState, long buildDuration) Send a notification when the job is complete
void	sendNonStageError(String jobName, String nodeName) Sends a notification for an error regardless of whether initial pending status was sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

GithubBuildNotifier

public GithubBuildNotifier(org.kohsuke.github.GHRepository repository,
                           String shaString,
                           String targetUrl)

Constructor

Parameters:

repository - the github repository

shaString - the commit notifications are being provided for

targetUrl - target Url (link back to Jenkins)

Method Detail

isEnabled

public boolean isEnabled()

Determine whether notifier is enabled

Specified by:

isEnabled in interface BuildNotifier

Returns:

true if enabled; false otherwise

notifyBuildState

public void notifyBuildState(String jobName,
                             String nodeName,
                             BuildState buildState)

Send stage status notification to github

Specified by:

notifyBuildState in interface BuildNotifier

Parameters:

nodeName - the node that has changed

buildState - the new state

jobName - the name of the job

notifyBuildStageStatus

public void notifyBuildStageStatus(String jobName,
                                   String nodeName,
                                   BuildState buildState,
                                   long nodeDuration)

Send stage status notification to github

Specified by:

notifyBuildStageStatus in interface BuildNotifier

Parameters:

nodeName - the stage name

buildState - the build status

nodeDuration - elapsed time for this node

jobName - the name of the job

notifyFinalBuildStatus

public void notifyFinalBuildStatus(String jobName,
                                   BuildState buildState,
                                   long buildDuration)

Send a notification when the job is complete

Specified by:

notifyFinalBuildStatus in interface BuildNotifier

Parameters:

jobName - the name of the job

buildState - state indicating success or failure

buildDuration - the build duration

sendNonStageError

public void sendNonStageError(String jobName,
                              String nodeName)

Sends a notification for an error regardless of whether initial pending status was sent. Useful for reporting errors for non-declarative pipelines since they can happen outside of a stage.

Specified by:

sendNonStageError in interface BuildNotifier

Parameters:

jobName - the name of the job

nodeName - the name of the node that failed