Package org.jenkinsci.plugins.github.pullrequest.publishers.impl

Class GitHubPRCommentPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.jenkinsci.plugins.github.pullrequest.publishers.GitHubPRAbstractPublisher

org.jenkinsci.plugins.github.pullrequest.publishers.impl.GitHubPRCommentPublisher

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class GitHubPRCommentPublisher
extends GitHubPRAbstractPublisher

Adds specified text to comments after build.

Author:

Alina Karpovich, Kanstantsin Shautsou

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubPRCommentPublisher.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

Modifier and Type	Field	Description
static GitHubPRMessage	DEFAULT_COMMENT

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
GitHubPRCommentPublisher()	Constructor with defaults.
GitHubPRCommentPublisher(GitHubPRMessage comment, StatusVerifier statusVerifier, PublisherErrorHandler errorHandler)

Method Summary

Modifier and Type	Method	Description
Api	getApi()
GitHubPRMessage	getComment()
GitHubPRCommentPublisher.DescriptorImpl	getDescriptor()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)

Methods inherited from class org.jenkinsci.plugins.github.pullrequest.publishers.GitHubPRAbstractPublisher

getErrorHandler, getRequiredMonitorService, getStatusVerifier, getTriggerDescriptor, handlePublisherError

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

Field Detail

DEFAULT_COMMENT

public static final GitHubPRMessage DEFAULT_COMMENT

Constructor Detail

GitHubPRCommentPublisher

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

Constructor with defaults. Only for groovy UI.

GitHubPRCommentPublisher

@DataBoundConstructor
public GitHubPRCommentPublisher(GitHubPRMessage comment,
                                StatusVerifier statusVerifier,
                                PublisherErrorHandler errorHandler)

Method Detail

perform

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

Throws:

InterruptedException

IOException

getApi

public final Api getApi()

getComment

public GitHubPRMessage getComment()

getDescriptor

public GitHubPRCommentPublisher.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Recorder