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

Class GitHubBranchCommitMessageCheck

java.lang.Object

hudson.model.AbstractDescribableImpl<GitHubBranchCommitCheck>

com.github.kostyasha.github.integration.branch.events.impl.commitchecks.GitHubBranchCommitCheck

com.github.kostyasha.github.integration.branch.events.impl.commitchecks.impl.GitHubBranchCommitMessageCheck

All Implemented Interfaces:

ExtensionPoint, Describable<GitHubBranchCommitCheck>

public class GitHubBranchCommitMessageCheck
extends GitHubBranchCommitCheck
implements ExtensionPoint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubBranchCommitMessageCheck.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
GitHubBranchCommitMessageCheck()

Method Summary

Modifier and Type	Method	Description
GitHubBranchCause	check(org.kohsuke.github.GHBranch remoteBranch, GitHubBranchRepository localRepo, org.kohsuke.github.GHCompare.Commit[] commits)	Check used to determine if some associated commit property, such as the commit message, should prevent a build from being triggered.
GitHubBranchCause	doCheck(org.kohsuke.github.GHBranch remoteBranch, GitHubBranchRepository localRepo, org.kohsuke.github.GHCommit commit)
String	getMatchCriteria()
boolean	isExclude()
void	setExclude(boolean exclude)
void	setMatchCriteria(String matchCriteria)

Methods inherited from class com.github.kostyasha.github.integration.branch.events.impl.commitchecks.GitHubBranchCommitCheck

check, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubBranchCommitMessageCheck

@DataBoundConstructor
public GitHubBranchCommitMessageCheck()

Method Detail

doCheck

public GitHubBranchCause doCheck(org.kohsuke.github.GHBranch remoteBranch,
                                 GitHubBranchRepository localRepo,
                                 org.kohsuke.github.GHCommit commit)
                          throws IOException

Specified by:

doCheck in class GitHubBranchCommitCheck

Throws:

IOException

check

public GitHubBranchCause check(org.kohsuke.github.GHBranch remoteBranch,
                               GitHubBranchRepository localRepo,
                               org.kohsuke.github.GHCompare.Commit[] commits)

Description copied from class: GitHubBranchCommitCheck

Check used to determine if some associated commit property, such as the commit message, should prevent a build from being triggered.

Specified by:

check in class GitHubBranchCommitCheck

Parameters:

remoteBranch - current branch state from GH.

localRepo - local repository state.

commits - commits commits that occurred between the last known local hash and the current remote.

Returns:

GitHubBranchCause instance indicating if the build should be skipped, null otherwise.

getMatchCriteria

public String getMatchCriteria()

isExclude

public boolean isExclude()

setExclude

@DataBoundSetter
public void setExclude(boolean exclude)

setMatchCriteria

@DataBoundSetter
public void setMatchCriteria(String matchCriteria)