top.infra.maven.extension.shared

Enum VcsProperties

java.lang.Object

java.lang.Enum<VcsProperties>

top.infra.maven.extension.shared.VcsProperties

All Implemented Interfaces:

Serializable, Comparable<VcsProperties>, CiOption

public enum VcsProperties
extends Enum<VcsProperties>
implements CiOption

Enum Constant Summary

Enum Constants

Enum Constant and Description
GIT_COMMIT_ID `git rev-parse HEAD`.
GIT_REF_NAME Auto detect current build ref name by CI environment variables or local git info.
GIT_REMOTE_ORIGIN_URL

Method Summary

Modifier and Type	Method and Description
Optional<String>	getDefaultValue()
String	getPropertyName()
static Optional<String>	gitRepoSlug(CiOptionContext ciOptionContext) Get slug info of current repository (directory).
static boolean	isReleaseRef(String gitRef)
static boolean	isSnapshotRef(String gitRef)
static VcsProperties	valueOf(String name) Returns the enum constant of this type with the specified name.
static VcsProperties[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface top.infra.maven.CiOption

calculateValue, findInProperties, getEnvVariableName, getSystemPropertyName, getValue, name, setProperties

Enum Constant Detail

GIT_COMMIT_ID

public static final VcsProperties GIT_COMMIT_ID

`git rev-parse HEAD`.

GIT_REF_NAME

public static final VcsProperties GIT_REF_NAME

Auto detect current build ref name by CI environment variables or local git info. Current build ref name, i.e. develop, release ...

travis-ci
TRAVIS_BRANCH for travis-ci, see: https://docs.travis-ci.com/user/environment-variables/
for builds triggered by a tag, this is the same as the name of the tag (TRAVIS_TAG).

appveyor
APPVEYOR_REPO_BRANCH - build branch. For Pull Request commits it is base branch PR is merging into
APPVEYOR_REPO_TAG - true if build has started by pushed tag; otherwise false
APPVEYOR_REPO_TAG_NAME - contains tag name for builds started by tag; otherwise this variable is

GIT_REMOTE_ORIGIN_URL

public static final VcsProperties GIT_REMOTE_ORIGIN_URL

Method Detail

values

public static VcsProperties[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VcsProperties c : VcsProperties.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VcsProperties valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isSnapshotRef

public static boolean isSnapshotRef(String gitRef)

isReleaseRef

public static boolean isReleaseRef(String gitRef)

gitRepoSlug

public static Optional<String> gitRepoSlug(CiOptionContext ciOptionContext)

Get slug info of current repository (directory).

Parameters:

ciOptionContext - ciOptionContext

Returns:

'group/project' or 'owner/project'

getDefaultValue

public Optional<String> getDefaultValue()

Specified by:

getDefaultValue in interface CiOption

getPropertyName

public String getPropertyName()

Specified by:

getPropertyName in interface CiOption