hudson.plugins.git

Class GitSCM

java.lang.Object

hudson.scm.SCM

hudson.plugins.git.GitSCMBackwardCompatibility

hudson.plugins.git.GitSCM

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>, Serializable

public class GitSCM
extends GitSCMBackwardCompatibility

Git SCM.

Author:

Nigel Magnay, Andrew Bayer, Nicolas Deloof, Kohsuke Kawaguchi ... and many others

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitSCM.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	GIT_BRANCH
static String	GIT_COMMIT
static String	GIT_LOCAL_BRANCH
static String	GIT_PREVIOUS_COMMIT
static String	GIT_PREVIOUS_SUCCESSFUL_COMMIT
static Pattern	GIT_REF
String	gitTool
static int	MAX_CHANGELOG To avoid pointlessly large changelog, we'll limit the number of changes up to this.
static boolean	VERBOSE Set to true to enable more logging to build's TaskListener.

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
GitSCM(List<UserRemoteConfig> userRemoteConfigs, List<BranchSpec> branches, Boolean doGenerateSubmoduleConfigurations, Collection<SubmoduleConfig> submoduleCfg, GitRepositoryBrowser browser, String gitTool, List<GitSCMExtension> extensions)
GitSCM(String repositoryUrl) A convenience constructor that sets everything to default.

Method Summary

Methods

Modifier and Type	Method and Description
void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, Map<String,String> env)
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.Run<?,?> abstractBuild, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener taskListener)
void	checkout(hudson.model.Run<?,?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, File changelogFile, hudson.scm.SCMRevisionState baseline)
hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.Job<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState baseline)
static void	configureXtream()
BuildData	copyBuildData(hudson.model.Run build) Like getBuildData(Run), but copy the data into a new object, which is used as the first step for updating the data for the next build.
hudson.scm.ChangeLogParser	createChangeLogParser()
org.jenkinsci.plugins.gitclient.GitClient	createClient(hudson.model.TaskListener listener, hudson.EnvVars environment, hudson.model.Run<?,?> build, hudson.FilePath workspace) Allows Builders and Publishers to access a configured GitClient object to perform additional git operations.
static List<UserRemoteConfig>	createRepoList(String url, String credentialsId)
String	deriveLocalBranchName(String remoteBranchName) Derives a local branch name from the remote branch name by removing the name of the remote from the remote branch name.
List<BranchSpec>	getBranches()
GitRepositoryBrowser	getBrowser()
BuildChooser	getBuildChooser()
BuildData	getBuildData(hudson.model.Run build) Find the build log (BuildData) recorded with the last build that completed.
BuildData	getBuildData(hudson.model.Run build, boolean clone) Deprecated.
hudson.model.AbstractBuild<?,?>	getBySHA1(String sha1) Web-bound method to let people look up a build by their SHA1 commit.
hudson.util.DescribableList<GitSCMExtension,GitSCMExtensionDescriptor>	getExtensions() All the configured extensions attached to this GitSCM.
String	getGitExe(hudson.model.Node builtOn, hudson.EnvVars env, hudson.model.TaskListener listener) Exposing so that we can get this from GitPublisher.
String	getGitExe(hudson.model.Node builtOn, hudson.model.TaskListener listener)
String	getGitTool()
String	getKey()
PreBuildMergeOptions	getMergeOptions() Deprecated.
static String	getParameterString(String original, hudson.EnvVars env)
org.eclipse.jgit.transport.RemoteConfig	getParamExpandedRepo(hudson.EnvVars env, org.eclipse.jgit.transport.RemoteConfig remoteRepository) Expand Parameters in the supplied remote repository with the parameter values provided in the given environment variables }
List<org.eclipse.jgit.transport.RemoteConfig>	getParamExpandedRepos(hudson.model.Run<?,?> build) Deprecated.
List<org.eclipse.jgit.transport.RemoteConfig>	getParamExpandedRepos(hudson.model.Run<?,?> build, hudson.model.TaskListener listener) Expand parameters in remoteRepositories with the parameter values provided in the given build and return them.
String	getParamLocalBranch(hudson.model.Run<?,?> build) Deprecated.
String	getParamLocalBranch(hudson.model.Run<?,?> build, hudson.model.TaskListener listener) Gets the parameter-expanded effective value in the context of the current build.
List<org.eclipse.jgit.transport.RemoteConfig>	getRepositories()
org.eclipse.jgit.transport.RemoteConfig	getRepositoryByName(String repoName)
Collection<SubmoduleConfig>	getSubmoduleCfg()
List<UserRemoteConfig>	getUserRemoteConfigs()
hudson.scm.RepositoryBrowser<?>	guessBrowser()
boolean	isCreateAccountBasedOnEmail()
boolean	isDoGenerateSubmoduleConfigurations()
static void	onLoaded()
Object	readResolve()
boolean	requiresWorkspaceForPolling()
hudson.plugins.git.GitTool	resolveGitTool(hudson.model.TaskListener listener)
void	setBuildChooser(BuildChooser buildChooser)
void	setSubmoduleCfg(Collection<SubmoduleConfig> submoduleCfg)
protected hudson.FilePath	workingDirectory(hudson.model.Job<?,?> context, hudson.FilePath workspace, hudson.EnvVars environment, hudson.model.TaskListener listener) Given the workspace, gets the working directory, which will be the workspace if no relative target dir is specified.

Methods inherited from class hudson.plugins.git.GitSCMBackwardCompatibility

getAuthorOrCommitter, getClean, getDescriptor, getDisableSubmodules, getExcludedRegions, getExcludedRegionsNormalized, getExcludedUsers, getExcludedUsersNormalized, getGitConfigEmail, getGitConfigEmailToUse, getGitConfigName, getGitConfigNameToUse, getIncludedRegions, getIncludedRegionsNormalized, getLocalBranch, getPruneBranches, getRecursiveSubmodules, getReference, getRelativeTargetDir, getRemotePoll, getScmName, getSkipTag, getTrackingSubmodules, getUserMergeOptions, getUseShallowClone, getWipeOutWorkspace, isIgnoreNotifyCommit

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getEffectiveBrowser, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, supportsPolling

Methods inherited from class java.lang.Object

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

Field Detail

gitTool

@CheckForNull
public String gitTool

GIT_BRANCH

public static final String GIT_BRANCH

See Also:

Constant Field Values

GIT_LOCAL_BRANCH

public static final String GIT_LOCAL_BRANCH

See Also:

Constant Field Values

GIT_COMMIT

public static final String GIT_COMMIT

See Also:

Constant Field Values

GIT_PREVIOUS_COMMIT

public static final String GIT_PREVIOUS_COMMIT

See Also:

Constant Field Values

GIT_PREVIOUS_SUCCESSFUL_COMMIT

public static final String GIT_PREVIOUS_SUCCESSFUL_COMMIT

See Also:

Constant Field Values

GIT_REF

public static final Pattern GIT_REF

VERBOSE

public static boolean VERBOSE

Set to true to enable more logging to build's TaskListener. Used by various classes in this package.

MAX_CHANGELOG

public static final int MAX_CHANGELOG

To avoid pointlessly large changelog, we'll limit the number of changes up to this.

Constructor Detail

GitSCM

public GitSCM(String repositoryUrl)

A convenience constructor that sets everything to default.

Parameters:

repositoryUrl - Repository URL to clone from.

GitSCM

@DataBoundConstructor
public GitSCM(List<UserRemoteConfig> userRemoteConfigs,
                           List<BranchSpec> branches,
                           Boolean doGenerateSubmoduleConfigurations,
                           Collection<SubmoduleConfig> submoduleCfg,
                           @CheckForNull
                           GitRepositoryBrowser browser,
                           @CheckForNull
                           String gitTool,
                           @NonNull
                           List<GitSCMExtension> extensions)

Method Detail

getSubmoduleCfg

public Collection<SubmoduleConfig> getSubmoduleCfg()

setSubmoduleCfg

public void setSubmoduleCfg(Collection<SubmoduleConfig> submoduleCfg)

createRepoList

public static List<UserRemoteConfig> createRepoList(String url,
                                    String credentialsId)

getExtensions

public hudson.util.DescribableList<GitSCMExtension,GitSCMExtensionDescriptor> getExtensions()

All the configured extensions attached to this GitSCM. Going forward this is primarily how we'll support esoteric use cases.

Since:

1.EXTENSION

readResolve

public Object readResolve()
                   throws IOException

Throws:

IOException

getBrowser

public GitRepositoryBrowser getBrowser()

Overrides:

getBrowser in class hudson.scm.SCM

guessBrowser

public hudson.scm.RepositoryBrowser<?> guessBrowser()

Overrides:

guessBrowser in class hudson.scm.SCM

isCreateAccountBasedOnEmail

public boolean isCreateAccountBasedOnEmail()

getBuildChooser

public BuildChooser getBuildChooser()

setBuildChooser

public void setBuildChooser(BuildChooser buildChooser)
                     throws IOException

Throws:

IOException

getParamLocalBranch

@Deprecated
public String getParamLocalBranch(hudson.model.Run<?,?> build)
                           throws IOException,
                                  InterruptedException

Deprecated.

Throws:

IOException

InterruptedException

getParamLocalBranch

public String getParamLocalBranch(hudson.model.Run<?,?> build,
                         hudson.model.TaskListener listener)
                           throws IOException,
                                  InterruptedException

Gets the parameter-expanded effective value in the context of the current build.

Throws:

IOException

InterruptedException

getParamExpandedRepos

@Deprecated
public List<org.eclipse.jgit.transport.RemoteConfig> getParamExpandedRepos(hudson.model.Run<?,?> build)
                                                                    throws IOException,
                                                                           InterruptedException

Deprecated.

Throws:

IOException

InterruptedException

getParamExpandedRepos

public List<org.eclipse.jgit.transport.RemoteConfig> getParamExpandedRepos(hudson.model.Run<?,?> build,
                                                                  hudson.model.TaskListener listener)
                                                                    throws IOException,
                                                                           InterruptedException

Expand parameters in remoteRepositories with the parameter values provided in the given build and return them.

Returns:

can be empty but never null.

Throws:

IOException

InterruptedException

getParamExpandedRepo

public org.eclipse.jgit.transport.RemoteConfig getParamExpandedRepo(hudson.EnvVars env,
                                                           org.eclipse.jgit.transport.RemoteConfig remoteRepository)

Expand Parameters in the supplied remote repository with the parameter values provided in the given environment variables }

Parameters:

env - Environment variables with parameter values

remoteRepository - Remote repository with parameters

Returns:

remote repository with expanded parameters

getRepositoryByName

public org.eclipse.jgit.transport.RemoteConfig getRepositoryByName(String repoName)

getUserRemoteConfigs

@Exported
public List<UserRemoteConfig> getUserRemoteConfigs()

getRepositories

public List<org.eclipse.jgit.transport.RemoteConfig> getRepositories()

deriveLocalBranchName

public String deriveLocalBranchName(String remoteBranchName)

Derives a local branch name from the remote branch name by removing the name of the remote from the remote branch name.

Ex. origin/master becomes master

Cycles through the list of user remotes looking for a match allowing user to configure an alternalte (not origin) name for the remote.

Parameters:

remoteBranchName -

Returns:

a local branch name derived by stripping the remote repository name from the remoteBranchName parameter. If a matching remote is not found, the original remoteBranchName will be returned.

getGitTool

@CheckForNull
public String getGitTool()

getParameterString

public static String getParameterString(String original,
                        hudson.EnvVars env)

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(hudson.model.Run<?,?> abstractBuild,
                                                 hudson.FilePath workspace,
                                                 hudson.Launcher launcher,
                                                 hudson.model.TaskListener taskListener)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

compareRemoteRevisionWith

public hudson.scm.PollingResult compareRemoteRevisionWith(hudson.model.Job<?,?> project,
                                                 hudson.Launcher launcher,
                                                 hudson.FilePath workspace,
                                                 hudson.model.TaskListener listener,
                                                 hudson.scm.SCMRevisionState baseline)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

createClient

public org.jenkinsci.plugins.gitclient.GitClient createClient(hudson.model.TaskListener listener,
                                                     hudson.EnvVars environment,
                                                     hudson.model.Run<?,?> build,
                                                     hudson.FilePath workspace)
                                                       throws IOException,
                                                              InterruptedException

Allows Builders and Publishers to access a configured GitClient object to perform additional git operations.

Throws:

IOException

InterruptedException

resolveGitTool

public hudson.plugins.git.GitTool resolveGitTool(hudson.model.TaskListener listener)

getGitExe

public String getGitExe(hudson.model.Node builtOn,
               hudson.model.TaskListener listener)

getGitExe

public String getGitExe(hudson.model.Node builtOn,
               hudson.EnvVars env,
               hudson.model.TaskListener listener)

Exposing so that we can get this from GitPublisher.

getBySHA1

public hudson.model.AbstractBuild<?,?> getBySHA1(String sha1)

Web-bound method to let people look up a build by their SHA1 commit.

checkout

public void checkout(hudson.model.Run<?,?> build,
            hudson.Launcher launcher,
            hudson.FilePath workspace,
            hudson.model.TaskListener listener,
            File changelogFile,
            hudson.scm.SCMRevisionState baseline)
              throws IOException,
                     InterruptedException

Overrides:

checkout in class hudson.scm.SCM

Throws:

IOException

InterruptedException

buildEnvVars

public void buildEnvVars(hudson.model.AbstractBuild<?,?> build,
                Map<String,String> env)

Overrides:

buildEnvVars in class hudson.scm.SCM

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

isDoGenerateSubmoduleConfigurations

public boolean isDoGenerateSubmoduleConfigurations()

getBranches

@Exported
public List<BranchSpec> getBranches()

getKey

public String getKey()

Overrides:

getKey in class hudson.scm.SCM

getMergeOptions

@Exported
@Deprecated
public PreBuildMergeOptions getMergeOptions()
                                     throws hudson.model.Descriptor.FormException

Deprecated.

Use PreBuildMerge.

Throws:

hudson.model.Descriptor.FormException

getBuildData

public BuildData getBuildData(hudson.model.Run build,
                     boolean clone)

Deprecated.

copyBuildData

public BuildData copyBuildData(hudson.model.Run build)

Like getBuildData(Run), but copy the data into a new object, which is used as the first step for updating the data for the next build.

getBuildData

@CheckForNull
public BuildData getBuildData(hudson.model.Run build)

Find the build log (BuildData) recorded with the last build that completed. BuildData may not be recorded if an exception occurs in the plugin logic.

Parameters:

build -

Returns:

the last recorded build data

workingDirectory

protected hudson.FilePath workingDirectory(hudson.model.Job<?,?> context,
                               hudson.FilePath workspace,
                               hudson.EnvVars environment,
                               hudson.model.TaskListener listener)
                                    throws IOException,
                                           InterruptedException

Given the workspace, gets the working directory, which will be the workspace if no relative target dir is specified. Otherwise, it'll be "workspace/relativeTargetDir".

Parameters:

workspace -

Returns:

working directory or null if workspace is null

Throws:

IOException

InterruptedException

onLoaded

@Initializer(after=PLUGINS_STARTED)
public static void onLoaded()

configureXtream

@Initializer(before=JOB_LOADED)
public static void configureXtream()