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:
-
Nested Class Summary
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncheck
(GitHubBranchDecisionContext context) indicates that branch was createdcheckHook
(GitHubBranchTrigger githubTrigger, org.kohsuke.github.GHEventPayload payload, TaskListener listener) Check that is used for lightweight hooks (pure GitHub hooks).
-
Constructor Details
-
GitHubBranchEvent
public GitHubBranchEvent()
-
-
Method Details
-
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
- Specified by:
getDescriptor
in interfaceDescribable<GitHubBranchEvent>
- Overrides:
getDescriptor
in classAbstractDescribableImpl<GitHubBranchEvent>
-