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

Class Mercurial

source code

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

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

Instance Methods
 
__init__(self, repourl=None, baseURL=None, defaultBranch=None, branchType='dirname', clobberOnBranchChange=True, **kwargs) source code
 
startVC(self, branch, revision, patch) source code
 
computeSourceRevision(self, changes)
Each subclass must implement this method to do something more precise than -rHEAD every time.
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 = 'hg'

Inherited from Source: branch, flunkOnFailure, haltOnFailure, notReally

Inherited from process.buildstep.LoggingBuildStep: 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, baseURL=None, defaultBranch=None, branchType='dirname', clobberOnBranchChange=True, **kwargs)
(Constructor)

source code 
Parameters:
  • repourl (string) - the URL which points at the Mercurial repository. This uses the 'default' branch unless defaultBranch is specified below and the branchType is set to 'inrepo'. It is an error to specify a branch without setting the branchType to 'inrepo'.
  • baseURL - if 'dirname' branches are enabled, this is the base URL to which a branch name will be appended. It should probably end in a slash. Use exactly one of repourl and baseURL.
  • defaultBranch - if branches are enabled, this is the branch to use if the Build does not specify one explicitly. For 'dirname' branches, It will simply be appended to baseURL and the result handed to the 'hg update' command. For 'inrepo' branches, this specifies the named revision to which the tree will update after a clone.
  • branchType - either 'dirname' or 'inrepo' depending on whether the branch name should be appended to the baseURL or the branch is a mercurial named branch and can be found within the repourl
  • clobberOnBranchChange - boolean, defaults to True. If set and using inrepos branches, clobber the tree at each branch change. Otherwise, just update to the branch.
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)