org.jenkinsci.plugins.githubissues

Class GitHubIssueNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

org.jenkinsci.plugins.githubissues.GitHubIssueNotifier

All Implemented Interfaces:

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

public class GitHubIssueNotifier
extends hudson.tasks.Notifier
implements jenkins.tasks.SimpleBuildStep

Notifier that creates GitHub issues when builds fail, and automatically closes the issue once the build starts passing again.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitHubIssueNotifier.DescriptorImpl

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

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

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

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
GitHubIssueNotifier() Initialises the GitHubIssueNotifier instance.
GitHubIssueNotifier(String issueTitle, String issueBody, String issueLabel, String issueRepo, boolean issueReopen, boolean issueAppend) Initialises the GitHubIssueNotifier instance.

Method Summary

Modifier and Type	Method and Description
GitHubIssueNotifier.DescriptorImpl	getDescriptor()
String	getIssueBody() Returns the issue body.
String	getIssueLabel() Returns the issue label.
String	getIssueRepo() An alternative repo to report the issues.
String	getIssueTitle() Returns the issue title.
org.kohsuke.github.GHRepository	getRepoForRun(hudson.model.Run<?,?> run) Gets the GitHub repository for the specified job.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	isIssueAppend() Flag to switch between commenting an issue on continuous failure or just on first failure.
boolean	isIssueReopen() Flag to switch between reopening an existing issue or creating a new one.
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setIssueAppend(boolean issueAppend)
void	setIssueBody(String issueBody)
void	setIssueLabel(String issueLabel)
void	setIssueReopen(boolean issueReopen)
void	setIssueRepo(String issueRepo)
void	setIssueTitle(String issueTitle)

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

Constructor Detail

GitHubIssueNotifier

@DataBoundConstructor
public GitHubIssueNotifier()

Initialises the GitHubIssueNotifier instance.

GitHubIssueNotifier

public GitHubIssueNotifier(String issueTitle,
                           String issueBody,
                           String issueLabel,
                           String issueRepo,
                           boolean issueReopen,
                           boolean issueAppend)

Initialises the GitHubIssueNotifier instance.

Parameters:

issueTitle - the issue title

issueBody - the issue body

issueLabel - the issue label

issueRepo - the issue repo

issueReopen - reopen the issue

issueAppend - append to existing issue

Method Detail

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getDescriptor

public GitHubIssueNotifier.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier

getRepoForRun

public org.kohsuke.github.GHRepository getRepoForRun(hudson.model.Run<?,?> run)
                                              throws GitHubRepositoryException

Gets the GitHub repository for the specified job.

Parameters:

run - The run

Returns:

The GitHub repository

Throws:

GitHubRepositoryException - when the GitHub repository can not be loaded

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

getIssueTitle

public String getIssueTitle()

Returns the issue title.

Returns:

the issue title

setIssueTitle

@DataBoundSetter
public void setIssueTitle(String issueTitle)

getIssueBody

public String getIssueBody()

Returns the issue body.

Returns:

the issue body

setIssueBody

@DataBoundSetter
public void setIssueBody(String issueBody)

getIssueLabel

public String getIssueLabel()

Returns the issue label.

Returns:

the issue label

setIssueLabel

@DataBoundSetter
public void setIssueLabel(String issueLabel)

isIssueReopen

public boolean isIssueReopen()

Flag to switch between reopening an existing issue or creating a new one.

Returns:

true if an existing issue should be reopened.

setIssueReopen

@DataBoundSetter
public void setIssueReopen(boolean issueReopen)

isIssueAppend

public boolean isIssueAppend()

Flag to switch between commenting an issue on continuous failure or just on first failure.

Returns:

true if an issue should be commented continuously on feach failures.

setIssueAppend

@DataBoundSetter
public void setIssueAppend(boolean issueAppend)

getIssueRepo

public String getIssueRepo()

An alternative repo to report the issues.

Returns:

the url of the issue repo if set

setIssueRepo

@DataBoundSetter
public void setIssueRepo(String issueRepo)