com.atlassian.bamboo.specs.builders.repository.github

Class GitHubRepository

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<T>

com.atlassian.bamboo.specs.api.builders.RootEntityPropertiesBuilder<E>

com.atlassian.bamboo.specs.api.builders.repository.VcsRepository<GitHubRepository,GitHubRepositoryProperties>

com.atlassian.bamboo.specs.builders.repository.github.GitHubRepository

public class GitHubRepository
extends VcsRepository<GitHubRepository,GitHubRepositoryProperties>

GitHub repository.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.api.builders.repository.VcsRepository

description, name, oid, parent, repositoryViewer, TYPE

Constructor Summary

Constructors

Constructor and Description
GitHubRepository()

Method Summary

Modifier and Type	Method and Description
GitHubRepository	authentication(UserPasswordAuthentication userPasswordAuthentication) Specifies username/access token authentication.
GitHubRepository	baseUrl(String baseUrl) Checks base Url.
GitHubRepository	branch(String branch) Sets branch to check out.
protected GitHubRepositoryProperties	build()
GitHubRepository	changeDetection(VcsChangeDetection vcsChangeDetection) Sets change detection options for this repository.
GitHubRepository	commandTimeout(Duration commandTimeout) Specifies how much time is given for git commands to finish.
GitHubRepository	commandTimeoutInMinutes(int commandTimeoutMinutes) Specifies how much time in minutes is given for git commands to finish.
GitHubRepository	defaultChangeDetection() Resets all change detection options to defaults.
GitHubRepository	fetchWholeRepository(boolean fetchWholeRepository) Enforces (or not) fetching all remote refs from the repository rather than single branch.
GitHubRepository	lfsEnabled(boolean useLfs) Enables/disables git lfs support.
GitHubRepository	remoteAgentCacheEnabled(boolean useRemoteAgentCache) Enables/disables caching repository content on the remote and elastic agents.
GitHubRepository	repository(String repository) Sets gitHub repository name.
GitHubRepository	shallowClonesEnabled(boolean useShallowClones) Enables/disables shallow clones when checking out from the repository.
GitHubRepository	submodulesEnabled(boolean useSubmodules) Enables/disables submodule support.
GitHubRepository	verboseLogs(boolean verboseLogs) Enables/disables verbose logs from git commands.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.repository.VcsRepository

description, getIdentifier, getName, getOid, humanReadableId, humanReadableType, name, oid, oid, parent, repositoryViewer

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubRepository

public GitHubRepository()

Method Detail

repository

public GitHubRepository repository(@NotNull
                                   String repository)

Sets gitHub repository name.

Parameters:

repository - repository name.

branch

public GitHubRepository branch(@NotNull
                               String branch)

Sets branch to check out.

authentication

public GitHubRepository authentication(@NotNull
                                       UserPasswordAuthentication userPasswordAuthentication)

Specifies username/access token authentication.

shallowClonesEnabled

public GitHubRepository shallowClonesEnabled(boolean useShallowClones)

Enables/disables shallow clones when checking out from the repository. Fetches the shallowest commit history possible. Do not use if your build depends on full repository history. Shallow clones are switched off by default.

submodulesEnabled

public GitHubRepository submodulesEnabled(boolean useSubmodules)

Enables/disables submodule support. Turned off by default.

remoteAgentCacheEnabled

public GitHubRepository remoteAgentCacheEnabled(boolean useRemoteAgentCache)

Enables/disables caching repository content on the remote and elastic agents. Bamboo uses caching to reduce bandwidth needed when retrieving source code from the repository. The feature is turned on by default.

commandTimeout

public GitHubRepository commandTimeout(Duration commandTimeout)

Specifies how much time is given for git commands to finish. Default is 180 minutes.

commandTimeoutInMinutes

public GitHubRepository commandTimeoutInMinutes(int commandTimeoutMinutes)

Specifies how much time in minutes is given for git commands to finish. Default is 180 minutes.

verboseLogs

public GitHubRepository verboseLogs(boolean verboseLogs)

Enables/disables verbose logs from git commands. Off by default.

fetchWholeRepository

public GitHubRepository fetchWholeRepository(boolean fetchWholeRepository)

Enforces (or not) fetching all remote refs from the repository rather than single branch. Off by default.

lfsEnabled

public GitHubRepository lfsEnabled(boolean useLfs)

Enables/disables git lfs support. Off by default.

defaultChangeDetection

public GitHubRepository defaultChangeDetection()

Resets all change detection options to defaults.

baseUrl

public GitHubRepository baseUrl(String baseUrl)

Checks base Url. Default is "https://github.com"

changeDetection

public GitHubRepository changeDetection(@NotNull
                                        VcsChangeDetection vcsChangeDetection)

Sets change detection options for this repository.

See Also:

VcsChangeDetection

build

protected GitHubRepositoryProperties build()
                                    throws PropertiesValidationException

Specified by:

build in class VcsRepository<GitHubRepository,GitHubRepositoryProperties>

Throws:

PropertiesValidationException