Package buildbot :: Package steps :: Module source :: Class Git
[frames] | no frames]

Class Git

source code

   process.buildstep.BuildStep --+        
                                 |        
process.buildstep.LoggingBuildStep --+    
                                     |    
                                Source --+
                                         |
                                        Git

Check out a source tree from a git repository 'repourl'.

Instance Methods
 
__init__(self, repourl=None, branch='master', submodules=False, ignore_ignores=None, reference=None, shallow=False, progress=False, **kwargs) source code
 
computeSourceRevision(self, changes)
Each subclass must implement this method to do something more precise than -rHEAD every time.
source code
 
startVC(self, branch, revision, patch) source code

Inherited from Source: commandComplete, computeRepositoryURL, describe, setDefaultWorkdir, setStepStatus, start

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, createSummary, evaluateCommand, getText, getText2, interrupt, maybeGetText2, setStatus, setupLogfiles, startCommand

Inherited from process.buildstep.BuildStep: acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getProperty, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuild, setBuildSlave, setProgress, setProperty, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Class Variables
  name = 'git'

Inherited from Source: branch, flunkOnFailure, haltOnFailure, notReally

Inherited from process.buildstep.LoggingBuildStep: cmd, logfiles, parms, progressMetrics

Inherited from process.buildstep.BuildStep: alwaysRun, doStepIf, flunkOnWarnings, locks, useProgress, warnOnFailure, warnOnWarnings

Instance Variables

Inherited from process.buildstep.BuildStep: build, progress, step_status

Method Details

__init__(self, repourl=None, branch='master', submodules=False, ignore_ignores=None, reference=None, shallow=False, progress=False, **kwargs)
(Constructor)

source code 
Parameters:
  • repourl (string) - the URL which points at the git repository
  • branch (string) - The branch or tag to check out by default. If a build specifies a different branch, it will be used instead of this.
  • submodules (boolean) - Whether or not to update (and initialize) git submodules.
  • reference (string) - The path to a reference repository to obtain objects from, if any.
  • shallow (boolean) - Use a shallow or clone, if possible
  • progress (boolean) - Pass the --progress option when fetching. This can solve long fetches getting killed due to lack of output, but requires Git 1.7.2+.
Overrides: process.buildstep.BuildStep.__init__

computeSourceRevision(self, changes)

source code 

Each subclass must implement this method to do something more precise than -rHEAD every time. For version control systems that use repository-wide change numbers (SVN, P4), this can simply take the maximum such number from all the changes involved in this build. For systems that do not (CVS), it needs to create a timestamp based upon the latest Change, the Build's treeStableTimer, and an optional self.checkoutDelay value.

Overrides: Source.computeSourceRevision
(inherited documentation)