Parameters¶
The Parameters module allows you to specify build parameters for a job.
- Component: parameters
- Macro
parameter
- Entry Point
jenkins_jobs.parameters
Example:
job:
name: test_job
parameters:
- string:
name: FOO
default: bar
description: "A parameter named FOO, defaults to 'bar'."
- class parameters.Parameters(registry)¶
- gen_xml(xml_parent, data)¶
Update the XML element tree based on YAML data. Override this method to add elements to the XML output. Create new Element objects and add them to the xml_parent. The YAML data structure must not be modified.
- Parameters
parser (YAMLParser) – the global YAML Parser
xml_parent (Element) – the parent XML element
data (dict) – the YAML data structure