Package org.jenkinsci.plugins.github.pullrequest.events

Class GitHubPREvent

java.lang.Object

hudson.model.AbstractDescribableImpl<GitHubPREvent>

org.jenkinsci.plugins.github.pullrequest.events.GitHubPREvent

All Implemented Interfaces:

ExtensionPoint, Describable<GitHubPREvent>

Direct Known Subclasses:

GitHubPRCloseEvent, GitHubPRCommentEvent, GitHubPRCommitEvent, GitHubPRDescriptionEvent, GitHubPRLabelAddedEvent, GitHubPRLabelExistsEvent, GitHubPRLabelNotExistsEvent, GitHubPRLabelPatternExistsEvent, GitHubPRLabelRemovedEvent, GitHubPRNonMergeableEvent, GitHubPRNumber, GitHubPROpenEvent

public abstract class GitHubPREvent
extends AbstractDescribableImpl<GitHubPREvent>
implements ExtensionPoint

Extension point for various GH PR events that may trigger run.

Author:

Kanstantsin Shautsou

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
GitHubPREvent()

Method Summary

Modifier and Type	Method	Description
GitHubPRCause	check(GitHubPRDecisionContext prDecisionContext)	indicates that PR was changed
GitHubPRCause	checkHook(GitHubPRTrigger gitHubPRTrigger, org.kohsuke.github.GHEventPayload payload, TaskListener listener)	Check that is used for lightweight hooks (pure GitHub hooks).
GitHubPREventDescriptor	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubPREvent

public GitHubPREvent()

Method Detail

check

@CheckForNull
public GitHubPRCause check(@NonNull
                           GitHubPRDecisionContext prDecisionContext)
                    throws IOException

indicates that PR was changed

Returns:

cause object. null when no influence (other events will be checked. If cause.isSkip() == true, then other checks wouldn't influence. And triggering for this branch will be skipped. If cause.isSkip() == false, indicates that branch build should be run.

Throws:

IOException

checkHook

public GitHubPRCause checkHook(GitHubPRTrigger gitHubPRTrigger,
                               org.kohsuke.github.GHEventPayload payload,
                               TaskListener listener)

Check that is used for lightweight hooks (pure GitHub hooks).

getDescriptor

public GitHubPREventDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<GitHubPREvent>

Overrides:

getDescriptor in class AbstractDescribableImpl<GitHubPREvent>