org.unbrokendome.gradle.plugins.gitversion.core

Interface RuleContext

All Known Subinterfaces:

PatternMatchRuleContext

All Known Implementing Classes:

AbstractRuleContext, PatternMatchRuleContextImpl

public interface RuleContext

Method Summary

Modifier and Type	Method and Description
default BranchPoint	branchPoint()
default BranchPoint	branchPoint(java.util.regex.Pattern otherBranchNamePattern)
default BranchPoint	branchPoint(java.lang.String... otherBranchNames)
default int	countCommitsSince(HasObjectId obj)
default TaggedCommit	findLatestTag(java.util.regex.Pattern tagNamePattern)
default TaggedCommit	findLatestTag(java.util.regex.Pattern tagNamePattern, boolean includeMerges)
default java.lang.String	getBranchName() Gets the short name of the current branch, i.e.
default GitBranch	getCurrentBranch()
default GitCommit	getHead() Gets the current HEAD commit.
org.gradle.api.Project	getProject() Gets the Gradle project.
GitRepository	getRepository() Gets the Git repository.
MutableSemVersion	getVersion()
boolean	isSkipOtherRules()
void	setSkipOtherRules(boolean skipOtherRules)
default void	setVersion(SemVersion version)
default void	setVersion(java.lang.String versionString)

Method Detail

getVersion

@Nonnull
MutableSemVersion getVersion()

setVersion

default void setVersion(SemVersion version)

setVersion

default void setVersion(java.lang.String versionString)

getProject

@Nonnull
org.gradle.api.Project getProject()

Gets the Gradle project.

Returns:

the Gradle Project

getRepository

@Nonnull
GitRepository getRepository()

Gets the Git repository.

Returns:

the GitRepository

getHead

@Nullable
default GitCommit getHead()

Gets the current HEAD commit.

Returns:

the current HEAD as a GitCommit, or null if the repository is empty

isSkipOtherRules

boolean isSkipOtherRules()

setSkipOtherRules

void setSkipOtherRules(boolean skipOtherRules)

getCurrentBranch

@Nullable
default GitBranch getCurrentBranch()

getBranchName

@Nullable
default java.lang.String getBranchName()

Gets the short name of the current branch, i.e. the branch that the HEAD points to. Returns null if the repository is in "detached head" state.

The short branch name does not include the refs/heads/ prefix.

Returns:

the short name of the current branch

branchPoint

@Nullable
default BranchPoint branchPoint()

branchPoint

@Nullable
default BranchPoint branchPoint(java.lang.String... otherBranchNames)

branchPoint

@Nullable
default BranchPoint branchPoint(java.util.regex.Pattern otherBranchNamePattern)

countCommitsSince

default int countCommitsSince(HasObjectId obj)

findLatestTag

@Nullable
default TaggedCommit findLatestTag(java.util.regex.Pattern tagNamePattern,
                                              boolean includeMerges)

findLatestTag

@Nullable
default TaggedCommit findLatestTag(java.util.regex.Pattern tagNamePattern)