com.brambolt.gradle

Class BuildPlugins

java.lang.Object

com.brambolt.gradle.BuildPlugins

public class BuildPlugins
extends java.lang.Object

Build plugin utilities.

Constructor Summary

Constructors

Constructor and Description
BuildPlugins()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getBramboltRelease(org.gradle.api.Project project) Accessor for the Brambolt release identifier.
static java.lang.String	getBramboltVersion(org.gradle.api.Project project) Accessor for the Brambolt version identifier.
static java.util.Optional<java.lang.String>	getBranchClassifier(org.gradle.api.Project project) Accessor for the default git branch classifier.
static java.util.Optional<java.lang.String>	getBranchClassifier(org.gradle.api.Project project, java.util.List<java.lang.String> prefixes, java.util.function.Function<java.lang.String,java.lang.String> formatter) Accessor for the branch classifier.
static java.lang.String	getBranchName(org.gradle.api.Project project) Accessor for the branch name.
static java.lang.String	getBuildDate(org.gradle.api.Project project) Accessor for the build timestamp.
static java.lang.String	getBuildNumber(org.gradle.api.Project project) Accessor for the build number.
static boolean	useBranchClassifiers(org.gradle.api.Project project) Indicates whether branch segments should be included when artifact classifiers are produced.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildPlugins

public BuildPlugins()

Method Detail

getBramboltRelease

public static java.lang.String getBramboltRelease(org.gradle.api.Project project)

Accessor for the Brambolt release identifier.

Parameters:

project - The project being built

Returns:

The Brambolt release identifier

getBramboltVersion

public static java.lang.String getBramboltVersion(org.gradle.api.Project project)

Accessor for the Brambolt version identifier.

Parameters:

project - The project being built

Returns:

The Brambolt version identifier

getBuildDate

public static java.lang.String getBuildDate(org.gradle.api.Project project)

Accessor for the build timestamp.

Parameters:

project - The project being built

Returns:

The build timestamp

getBuildNumber

public static java.lang.String getBuildNumber(org.gradle.api.Project project)

Accessor for the build number.

Parameters:

project - The project being built

Returns:

The build number

getBranchName

public static java.lang.String getBranchName(org.gradle.api.Project project)

Accessor for the branch name. Returns null if the vcsBranch project property has not been set.

This function uses the vcsBranch project property to avoid introducing a dependency on a particular source control system. The property name will be converted to a fully-qualified name.

Parameters:

project - The project to look up the branch name for

Returns:

The branch name for the parameter project

getBranchClassifier

public static java.util.Optional<java.lang.String> getBranchClassifier(org.gradle.api.Project project,
                                                                       java.util.List<java.lang.String> prefixes,
                                                                       java.util.function.Function<java.lang.String,java.lang.String> formatter)

Accessor for the branch classifier. If the active branch is not prefixed with a string in the prefixes parameter list then the return value is the formatted branch name.

Formatting applies the parameter formatter function to the branch name before it is concatenated to the Brambolt version.

Parameters:

project - The project being built

prefixes - The branch name prefixes identifying main branches

formatter - A formatting function for the branch name

Returns:

The git branch classifier

See Also:

useBranchClassifiers(Project)

getBranchClassifier

public static java.util.Optional<java.lang.String> getBranchClassifier(org.gradle.api.Project project)

Accessor for the default git branch classifier. The return value is the empty option if the project is on a main, master or release branch. Otherwise the formatted branch name is returned. Formatting replaces slashes with dashes.

Parameters:

project - The project being built

Returns:

The brambolt version identifier with branch suffix.

See Also:

getBranchClassifier(Project, List, Function), useBranchClassifiers(Project)

useBranchClassifiers

public static boolean useBranchClassifiers(org.gradle.api.Project project)

Indicates whether branch segments should be included when artifact classifiers are produced.

It is probably best never to use branch classifiers. Branch classifiers appear convenient for ensuring that snapshots built from branches on the same release never overwrite each other in the binary repository. This however unfortunately only works as long as the different branches produce identical POM files. As soon as POM content starts to vary across branches, the results in the binary repository will be undefined.

When tempted to use branch classifiers, create a new version instead.

Parameters:

project - The project being built

Returns:

true iff branch classifiers are in use