Package com.github.kostyasha.github.integration.branch.events

Class GitHubBranchEvent

java.lang.Object

hudson.model.AbstractDescribableImpl<GitHubBranchEvent>

com.github.kostyasha.github.integration.branch.events.GitHubBranchEvent

All Implemented Interfaces:

ExtensionPoint, Describable<GitHubBranchEvent>

Direct Known Subclasses:

GitHubBranchCommitEvent, GitHubBranchCreatedEvent, GitHubBranchDeletedEvent, GitHubBranchHashChangedEvent, GitHubBranchRestrictionFilter

public abstract class GitHubBranchEvent
extends AbstractDescribableImpl<GitHubBranchEvent>
implements ExtensionPoint

Different "events" that may want trigger run for branch.

Author:

Kanstantsin Shautsou

See Also:

GitHubPREvent

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
GitHubBranchEvent()

Method Summary

Modifier and Type	Method	Description
GitHubBranchCause	check(GitHubBranchDecisionContext context)	indicates that branch was created
GitHubBranchCause	checkHook(GitHubBranchTrigger githubTrigger, org.kohsuke.github.GHEventPayload payload, TaskListener listener)	Check that is used for lightweight hooks (pure GitHub hooks).
GitHubBranchEventDescriptor	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubBranchEvent

public GitHubBranchEvent()

Method Detail

check

@CheckForNull
public GitHubBranchCause check(@NonNull
                               GitHubBranchDecisionContext context)
                        throws IOException

indicates that branch was created

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 GitHubBranchCause checkHook(GitHubBranchTrigger githubTrigger,
                                   org.kohsuke.github.GHEventPayload payload,
                                   TaskListener listener)

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

getDescriptor

public GitHubBranchEventDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<GitHubBranchEvent>

Overrides:

getDescriptor in class AbstractDescribableImpl<GitHubBranchEvent>