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

Class GitHubPRLabelPatternExistsEvent

java.lang.Object

hudson.model.AbstractDescribableImpl<GitHubPREvent>

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

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

All Implemented Interfaces:

ExtensionPoint, Describable<GitHubPREvent>

public class GitHubPRLabelPatternExistsEvent
extends GitHubPREvent

Used to skip PR builder. Use case is skipping if PR is marked with some label or labels.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubPRLabelPatternExistsEvent.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
GitHubPRLabelPatternExistsEvent(GitHubPRLabel label, boolean skip)

Method Summary

Modifier and Type	Method	Description
GitHubPRCause	check(GitHubPRDecisionContext prDecisionContext)	indicates that PR was changed
GitHubPRLabel	getLabel()
boolean	isSkip()

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 Detail

GitHubPRLabelPatternExistsEvent

@DataBoundConstructor
public GitHubPRLabelPatternExistsEvent(GitHubPRLabel label,
                                       boolean skip)

Method Detail

check

public GitHubPRCause check(@NonNull
                           GitHubPRDecisionContext prDecisionContext)
                    throws IOException

Description copied from class: GitHubPREvent

indicates that PR was changed

Overrides:

check in class GitHubPREvent

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

getLabel

public GitHubPRLabel getLabel()

isSkip

public boolean isSkip()