pyjen.plugins.shellbuilder module

Interface to control a basic shell build step job builder plugin

pyjen.plugins.shellbuilder.PluginClass: alias of pyjen.plugins.shellbuilder.ShellBuilder

class pyjen.plugins.shellbuilder.ShellBuilder(node)[source]

Interface to control a basic shell build step job builder plugin

This plugin is a default, built-in plugin which is part of the Jenkins core

Parameters: node (xml.etree.ElementTree.Element) – XML node with the decoded XML data associated with a plugin

static get_jenkins_plugin_name()[source]

str: 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

classmethod instantiate(script)[source]

Factory method for creating a new shell build step

Parameters: script (str) – shell script to run as part of this build step
Returns: instance of this class
Return type: ShellBuilder

property script

the shell script associated with this builder

property unstable_return_code

the return code that marks the build as unstable