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

Class GitHubRepository

java.lang.Object

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

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

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, project, repositoryViewer, TYPE

Constructor Summary

Constructors

Constructor	Description
GitHubRepository()

Method Summary

Modifier and Type	Method	Description
GitHubRepository	appAuthentication(@NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)	Configures authentication using shared credentials for a GitHub App private key.
GitHubRepository	appAuthentication(@NotNull SshPrivateKeyAuthentication sshPrivateKeyAuthentication)	Configures authentication using a GitHub App private key.
GitHubRepository	appId(@NotNull String appId)	Sets the GitHub App ID.
GitHubRepository	authentication(@NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)	Deprecated. since 12.0, use patAuthentication(SharedCredentialsIdentifier).
GitHubRepository	authentication(@NotNull UserPasswordAuthentication userPasswordAuthentication)	Deprecated. since 12.0, use patAuthentication(UserPasswordAuthentication).
GitHubRepository	baseUrl(String baseUrl)	Checks base Url.
GitHubRepository	branch(@NotNull String branch)	Sets branch to check out.
protected GitHubRepositoryProperties	build()
GitHubRepository	changeDetection(@NotNull 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	patAuthentication(@NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)	Configures authentication using username/access token shared credentials.
GitHubRepository	patAuthentication(@NotNull UserPasswordAuthentication userPasswordAuthentication)	Configures authentication using a username and access token.
GitHubRepository	remoteAgentCacheEnabled(boolean useRemoteAgentCache)	Enables/disables caching repository content on the remote and elastic agents.
GitHubRepository	repository(@NotNull String repository)	Sets gitHub repository name.
GitHubRepository	shallowClonesEnabled(boolean useShallowClones)	Enables/disables shallow clones when checking out from the repository.
GitHubRepository	sshKeyAppliesToSubmodules(boolean sshKeyAppliesToSubmodules)	Enables/disabled authenticating to submodules with SSH key configured for this repository.
GitHubRepository	submodulesEnabled(boolean useSubmodules)	Enables/disables submodule support.
GitHubRepository	submodulesUseShallowClonesEnabled(boolean useSubmodulesWithShallowClones)	Enables/disables shallow clone support for submodules.
GitHubRepository	verboseLogs(boolean verboseLogs)	Enables/disables verbose logs from git commands.
GitHubRepository	webhookEnabled(boolean webhookEnabled)	Enables webhooks support for the repository.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubRepository

public GitHubRepository()

Method Details

repository

public GitHubRepository repository(@NotNull
 @NotNull String repository)

Sets gitHub repository name.

Parameters:

repository - repository name.

branch

public GitHubRepository branch(@NotNull
 @NotNull String branch)

Sets branch to check out.

authentication

@Deprecated
public GitHubRepository authentication(@NotNull
 @NotNull UserPasswordAuthentication userPasswordAuthentication)

Deprecated.

since 12.0, use patAuthentication(UserPasswordAuthentication).

Configures authentication using a username and access token.

This method sets up authentication for the GitHub repository by providing a UserPasswordAuthentication object. The object must contain valid credentials (username and access token) to access the repository.

Parameters:

userPasswordAuthentication - the authentication object containing the username and access token.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if userPasswordAuthentication is null.

authentication

@Deprecated
public GitHubRepository authentication(@NotNull
 @NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)

Deprecated.

since 12.0, use patAuthentication(SharedCredentialsIdentifier).

Configures authentication using username/access token shared credentials.

This method sets up authentication for the GitHub repository by selecting a previously defined username/access token SharedCredentials. Shared credentials are stored and managed separately, allowing reuse across multiple repositories.

Parameters:

sharedCredentialsIdentifier - the identifier for the shared credentials to use.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if sharedCredentialsIdentifier is null.

patAuthentication

public GitHubRepository patAuthentication(@NotNull
 @NotNull UserPasswordAuthentication userPasswordAuthentication)

Configures authentication using a username and access token.

This method sets up authentication for the GitHub repository by providing a UserPasswordAuthentication object. The object must contain valid credentials (username and access token) to access the repository.

Note: Use either Personal Access Token (PAT) authentication via this method or patAuthentication(UserPasswordAuthentication), or GitHub App authentication (App ID + App Authentication) via appId(String) and appAuthentication(SshPrivateKeyAuthentication) or appAuthentication(SharedCredentialsIdentifier).

Parameters:

userPasswordAuthentication - the authentication object containing the username and access token.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if userPasswordAuthentication is null.

patAuthentication

public GitHubRepository patAuthentication(@NotNull
 @NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)

Configures authentication using username/access token shared credentials.

This method sets up authentication for the GitHub repository by selecting a previously defined username/access token SharedCredentials. Shared credentials are stored and managed separately, allowing reuse across multiple repositories.

Note: Use either Personal Access Token (PAT) authentication via this method or patAuthentication(UserPasswordAuthentication), or GitHub App authentication (App ID + App Authentication) via appId(String) and appAuthentication(SshPrivateKeyAuthentication) or appAuthentication(SharedCredentialsIdentifier).

Parameters:

sharedCredentialsIdentifier - the identifier for the shared credentials to use.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if sharedCredentialsIdentifier is null.

appId

public GitHubRepository appId(@NotNull
 @NotNull String appId)

Sets the GitHub App ID.

This method specifies the App ID required for GitHub App authentication. To enable GitHub App authentication, this method must be used in combination with appAuthentication(SshPrivateKeyAuthentication) or appAuthentication(SharedCredentialsIdentifier).

Note: Use either GitHub App authentication (App ID + App Authentication) or Personal Access Token (PAT) authentication via patAuthentication(UserPasswordAuthentication) or patAuthentication(SharedCredentialsIdentifier).

Parameters:

appId - the GitHub App ID.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if appId is null.

Since:

12.0

appAuthentication

public GitHubRepository appAuthentication(@NotNull
 @NotNull SshPrivateKeyAuthentication sshPrivateKeyAuthentication)

Configures authentication using a GitHub App private key.

This method sets up authentication for the GitHub repository by providing an SshPrivateKeyAuthentication object. To enable GitHub App authentication, this method must be used in combination with appId(String).

Note: Use either GitHub App authentication (App ID + App Authentication) or Personal Access Token (PAT) authentication via patAuthentication(UserPasswordAuthentication) or patAuthentication(SharedCredentialsIdentifier).

Parameters:

sshPrivateKeyAuthentication - the authentication object containing the private key.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if sshPrivateKeyAuthentication is null.

Since:

12.0

appAuthentication

public GitHubRepository appAuthentication(@NotNull
 @NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)

Configures authentication using shared credentials for a GitHub App private key.

This method sets up authentication for the GitHub repository by selecting a previously defined SharedCredentials. To enable GitHub App authentication, this method must be used in combination with appId(String).

Note: Use either GitHub App authentication (App ID + App Authentication) or Personal Access Token (PAT) authentication via patAuthentication(UserPasswordAuthentication) or patAuthentication(SharedCredentialsIdentifier).

Parameters:

sharedCredentialsIdentifier - the identifier for the shared credentials to use.

Returns:

the current instance of GitHubRepository for method chaining.

Throws:

PropertiesValidationException - if sharedCredentialsIdentifier is null.

Since:

12.0

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.

submodulesUseShallowClonesEnabled

public GitHubRepository submodulesUseShallowClonesEnabled(boolean useSubmodulesWithShallowClones)

Enables/disables shallow clone support for submodules. Turned off by default.

sshKeyAppliesToSubmodules

public GitHubRepository sshKeyAppliesToSubmodules(boolean sshKeyAppliesToSubmodules)

Enables/disabled authenticating to submodules with SSH key configured for this repository.

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
 @NotNull VcsChangeDetection vcsChangeDetection)

Sets change detection options for this repository.

See Also:

• VcsChangeDetection

webhookEnabled

public GitHubRepository webhookEnabled(boolean webhookEnabled)

Enables webhooks support for the repository. Off by default.

Since:

10.1

build

protected GitHubRepositoryProperties build()
                                    throws PropertiesValidationException

Specified by:

build in class VcsRepository<GitHubRepository,GitHubRepositoryProperties>

Throws:

PropertiesValidationException