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

Class GitHubPRDescriptionEvent

java.lang.Object

hudson.model.AbstractDescribableImpl<GitHubPREvent>

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

org.jenkinsci.plugins.github.pullrequest.events.impl.GitHubPRDescriptionEvent

All Implemented Interfaces:

ExtensionPoint, Describable<GitHubPREvent>

public class GitHubPRDescriptionEvent
extends GitHubPREvent

Used to skip PR builder. Use case is skipping if special description exists.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubPRDescriptionEvent.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
GitHubPRDescriptionEvent(String skipMsg)

Method Summary

Modifier and Type	Method	Description
GitHubPRCause	check(GitHubPRDecisionContext prDecisionContext)	Checks for skip message in pull request description.
String	getSkipMsg()

Methods inherited from class org.jenkinsci.plugins.github.pullrequest.events.GitHubPREvent

checkHook, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubPRDescriptionEvent

@DataBoundConstructor
public GitHubPRDescriptionEvent(String skipMsg)

Method Details

check

public GitHubPRCause check(@NonNull
 GitHubPRDecisionContext prDecisionContext)
                    throws IOException

Checks for skip message in pull request description.

Overrides:

check in class GitHubPREvent

Parameters:

prDecisionContext - .remotePR GHIssue that contains description for checking

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

getSkipMsg

public String getSkipMsg()