Package jenkins.plugins.git

Class GitSCMSource

java.lang.Object

hudson.model.AbstractDescribableImpl<jenkins.scm.api.SCMSource>

jenkins.scm.api.SCMSource

jenkins.plugins.git.AbstractGitSCMSource

jenkins.plugins.git.GitSCMSource

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.scm.api.SCMSource>

public class GitSCMSource
extends AbstractGitSCMSource

A SCMSource that discovers branches in a git repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitSCMSource.DescriptorImpl
static class	GitSCMSource.ListenerImpl

Nested classes/interfaces inherited from class jenkins.plugins.git.AbstractGitSCMSource

AbstractGitSCMSource.SCMRevisionImpl, AbstractGitSCMSource.SpecificRevisionBuildChooser

Nested classes/interfaces inherited from class jenkins.scm.api.SCMSource

jenkins.scm.api.SCMSource.SourceByItem

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	IGNORE_TAG_DISCOVERY_TRAIT	Ignore the tag discovery trait when fetching multibranch Pipelines.
static final Logger	LOGGER

Fields inherited from class jenkins.plugins.git.AbstractGitSCMSource

DEFAULT_REMOTE_NAME, REF_SPEC_DEFAULT, REF_SPEC_REMOTE_NAME_PLACEHOLDER, REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR

Fields inherited from class jenkins.scm.api.SCMSource

PRONOUN

Constructor Summary

Constructors

Constructor	Description
GitSCMSource(String remote)
GitSCMSource(String id, String remote, String credentialsId, String includes, String excludes, boolean ignoreOnPushNotifications)	Deprecated.
GitSCMSource(String id, String remote, String credentialsId, String remoteName, String rawRefSpecs, String includes, String excludes, boolean ignoreOnPushNotifications)	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getCredentialsId()
String	getRawRefSpecs()	Deprecated.
protected List<org.eclipse.jgit.transport.RefSpec>	getRefSpecs()	Deprecated.
String	getRemote()
List<jenkins.scm.api.trait.SCMSourceTrait>	getTraits()	Returns the SCMSourceTrait instances for this AbstractGitSCMSource.
boolean	isIgnoreOnPushNotifications()	Deprecated.
protected Object	readResolve()
void	setBrowser(GitRepositoryBrowser browser)
void	setCredentialsId(String credentialsId)
void	setExtensions(List<GitSCMExtension> extensions)	Deprecated.
void	setGitTool(String gitTool)
void	setTraits(List<jenkins.scm.api.trait.SCMSourceTrait> traits)

Methods inherited from class jenkins.plugins.git.AbstractGitSCMSource

build, decorate, getBrowser, getCacheDir, getCacheDir, getCacheEntry, getCacheLock, getCredentials, getExcludes, getExtensions, getGitTool, getIncludes, getRemoteConfigs, getRemoteName, isCategoryEnabled, isExcluded, isFIPSCompliantTLS, newBuilder, resolveGitTool, resolveGitTool, resolveGitTool, retrieve, retrieve, retrieve, retrieveActions, retrieveActions, retrieveRevisions

Methods inherited from class jenkins.scm.api.SCMSource

afterSave, build, canProbe, checkInterrupt, createProbe, defaultListener, equals, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetchActions, fetchActions, fetchActions, fetchRevisions, fetchRevisions, fromSCMFileSystem, getCategories, getCriteria, getDescriptor, getId, getOwner, getPronoun, getTrustedRevision, hashCode, hasId, newProbe, parentHeads, parentRevisions, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveActions, retrieveRevisions, setId, setOwner, toString, withId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOGGER

public static final Logger LOGGER

IGNORE_TAG_DISCOVERY_TRAIT

public static boolean IGNORE_TAG_DISCOVERY_TRAIT

Ignore the tag discovery trait when fetching multibranch Pipelines. Git plugin versions 5.7.0 and earlier will always fetch tags when scanning a multibranch Pipeline, whether or not the tag discovery trait had been added. Releases after git plugin 5.7.0 honor the tag discovery trait when scanning a multibranch Pipeline. If the tag discovery trait has been added, then tags are fetched. If the tag discovery trait has not been added, then tags are not fetched. If honoring the tag discovery trait causes problems for a user, a Java property can be set during Jenkins startup to restore the previous (buggy) behavior. Refer to the plugin documentation for more details.

Constructor Details

GitSCMSource

@DataBoundConstructor
public GitSCMSource(String remote)

GitSCMSource

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("3.4.0")
public GitSCMSource(String id,
 String remote,
 String credentialsId,
 String remoteName,
 String rawRefSpecs,
 String includes,
 String excludes,
 boolean ignoreOnPushNotifications)

Deprecated.

GitSCMSource

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("3.4.0")
public GitSCMSource(String id,
 String remote,
 String credentialsId,
 String includes,
 String excludes,
 boolean ignoreOnPushNotifications)

Deprecated.

Method Details

setCredentialsId

@DataBoundSetter
public void setCredentialsId(@CheckForNull
 String credentialsId)

setTraits

@DataBoundSetter
public void setTraits(List<jenkins.scm.api.trait.SCMSourceTrait> traits)

Overrides:

setTraits in class jenkins.scm.api.SCMSource

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Throws:

ObjectStreamException

isIgnoreOnPushNotifications

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("3.4.0")
public boolean isIgnoreOnPushNotifications()

Deprecated.

setBrowser

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@DataBoundSetter
public void setBrowser(GitRepositoryBrowser browser)

setGitTool

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@DataBoundSetter
public void setGitTool(String gitTool)

setExtensions

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@DataBoundSetter
@Deprecated
public void setExtensions(@CheckForNull
 List<GitSCMExtension> extensions)

Deprecated.

getCredentialsId

public String getCredentialsId()

Specified by:

getCredentialsId in class AbstractGitSCMSource

getRemote

public String getRemote()

Specified by:

getRemote in class AbstractGitSCMSource

Returns:

Git remote URL

getRawRefSpecs

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("3.4.0")
public String getRawRefSpecs()

Deprecated.

getRefSpecs

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("3.4.0")
protected List<org.eclipse.jgit.transport.RefSpec> getRefSpecs()

Deprecated.

Overrides:

getRefSpecs in class AbstractGitSCMSource

Returns:

the ref specs.

getTraits

@NonNull
public List<jenkins.scm.api.trait.SCMSourceTrait> getTraits()

Description copied from class: AbstractGitSCMSource

Returns the SCMSourceTrait instances for this AbstractGitSCMSource.

Overrides:

getTraits in class AbstractGitSCMSource

Returns:

the SCMSourceTrait instances