Class GitHub

java.lang.Object

org.eluder.coveralls.maven.plugin.service.AbstractServiceSetup

org.eluder.coveralls.maven.plugin.service.GitHub

All Implemented Interfaces:

ServiceSetup

public class GitHub
extends AbstractServiceSetup

The Class GitHub.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GITHUB	The Constant GITHUB.
static final String	GITHUB_ACTIONS	The Constant GITHUB_ACTIONS.
static final String	GITHUB_REF	The Constant GITHUB_REF.
static final String	GITHUB_REF_NAME	The Constant GITHUB_REF_NAME.
static final String	GITHUB_REPOSITORY	The Constant GITHUB_REPOSITORY.
static final String	GITHUB_RUN_ID	The Constant GITHUB_RUN_ID.
static final String	GITHUB_RUN_NUMBER	The Constant GITHUB_RUN_NUMBER.
static final String	GITHUB_SERVER_URL	The Constant GITHUB_SERVER_URL.

Constructor Summary

Constructors

Constructor	Description
GitHub(Map<String,String> env)	Instantiates a new git hub.

Method Summary

Modifier and Type	Method	Description
String	getBranch()	Gets the branch.
String	getBuildNumber()	Gets the builds the number.
String	getBuildUrl()	Gets the builds the url.
Properties	getEnvironment()	Gets the environment.
String	getJobId()	Gets the job id.
String	getName()	Gets the name.
String	getPullRequest()	Gets the pull request.
boolean	isSelected()	Checks if is selected.

Methods inherited from class AbstractServiceSetup

addProperty, getProperty

Methods inherited from class Object

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

Field Details

GITHUB

public static final String GITHUB

The Constant GITHUB.

See Also:

• Constant Field Values

GITHUB_ACTIONS

public static final String GITHUB_ACTIONS

The Constant GITHUB_ACTIONS.

See Also:

• Constant Field Values

GITHUB_REF_NAME

public static final String GITHUB_REF_NAME

The Constant GITHUB_REF_NAME.

See Also:

• Constant Field Values

GITHUB_REPOSITORY

public static final String GITHUB_REPOSITORY

The Constant GITHUB_REPOSITORY.

See Also:

• Constant Field Values

GITHUB_RUN_ID

public static final String GITHUB_RUN_ID

The Constant GITHUB_RUN_ID.

See Also:

• Constant Field Values

GITHUB_RUN_NUMBER

public static final String GITHUB_RUN_NUMBER

The Constant GITHUB_RUN_NUMBER.

See Also:

• Constant Field Values

GITHUB_SERVER_URL

public static final String GITHUB_SERVER_URL

The Constant GITHUB_SERVER_URL.

See Also:

• Constant Field Values

GITHUB_REF

public static final String GITHUB_REF

The Constant GITHUB_REF.

See Also:

• Constant Field Values

Constructor Details

GitHub

public GitHub(Map<String,String> env)

Instantiates a new git hub.

Parameters:

env - the env

Method Details

isSelected

public boolean isSelected()

Description copied from interface: ServiceSetup

Checks if is selected.

Returns:

true if this service is selected, otherwise false

getName

public String getName()

Description copied from interface: ServiceSetup

Gets the name.

Returns:

service name

getJobId

public String getJobId()

Description copied from interface: ServiceSetup

Gets the job id.

Specified by:

getJobId in interface ServiceSetup

Overrides:

getJobId in class AbstractServiceSetup

Returns:

service job id, or null if not defined

getBuildNumber

public String getBuildNumber()

Description copied from interface: ServiceSetup

Gets the builds the number.

Specified by:

getBuildNumber in interface ServiceSetup

Overrides:

getBuildNumber in class AbstractServiceSetup

Returns:

service build number, or null if not defined

getBuildUrl

public String getBuildUrl()

Description copied from interface: ServiceSetup

Gets the builds the url.

Specified by:

getBuildUrl in interface ServiceSetup

Overrides:

getBuildUrl in class AbstractServiceSetup

Returns:

service build url, or null if not defined

getPullRequest

public String getPullRequest()

Description copied from interface: ServiceSetup

Gets the pull request.

Specified by:

getPullRequest in interface ServiceSetup

Overrides:

getPullRequest in class AbstractServiceSetup

Returns:

pull request identifier, or null if not defined

getBranch

public String getBranch()

Description copied from interface: ServiceSetup

Gets the branch.

Specified by:

getBranch in interface ServiceSetup

Overrides:

getBranch in class AbstractServiceSetup

Returns:

git branch name, or null if not defined

getEnvironment

public Properties getEnvironment()

Description copied from interface: ServiceSetup

Gets the environment.

Specified by:

getEnvironment in interface ServiceSetup

Overrides:

getEnvironment in class AbstractServiceSetup

Returns:

environment related to service, or null if not defined