pyjen.plugins.subversion module

Module defining the interfaces for interacting with Subversion properties associated with a pyjen.job.Job

class pyjen.plugins.subversion.ModuleLocation(node)[source]

Bases: pyjen.utils.xml_plugin.XMLPlugin

Interface to SCM module declarations in a Subversion property of a job

depth_option
Returns

the current SVN ‘depth’ options associated with this module

Return type

str

disable_ignore_externals()[source]

Disables the ‘ignore externals’ option on this SCM module

enable_ignore_externals()[source]

Enables the ‘ignore externals’ option on this SCM module

ignore_externals

see whether the ‘ignore externals’ option is enabled on this job

Returns

True if ignore externals is enabled, otherwise False

Return type

bool

local_dir

local folder where the source code for this module is checked out to

Return type

str

node

Gets the XML node associated with this plugin

Return type

ElementTree.Element

url

SVN URL where the source code for this module can be found

Return type

str

pyjen.plugins.subversion.PluginClass

alias of pyjen.plugins.subversion.Subversion

class pyjen.plugins.subversion.Subversion(node)[source]

Bases: pyjen.utils.xml_plugin.XMLPlugin

Subversion SCM job plugin

https://wiki.jenkins-ci.org/display/JENKINS/Subversion+Plugin

static get_jenkins_plugin_name()[source]

Gets the name of the Jenkins plugin associated with this PyJen plugin

This static method is used by the PyJen plugin API to associate this class with a specific Jenkins plugin, as it is encoded in the config.xml

Return type

str

included_regions

patterns of the regions of the SVN repo to include in SCM operations

Return type

list of str

locations

Gets the list of SVN URLs associated with this plugin instance

Returns

set of 0 or more ModuleLocation objects describing the SVN parameters for this module.

Return type

list of ModuleLocation objects