Add some missing docs.

Change-Id: I6d726c3ad281cf11e44f37a48256fb88ea1546a2
This commit is contained in:
James E. Blair 2012-09-17 23:43:26 +02:00
parent 78c083f590
commit b02597ac86
2 changed files with 31 additions and 10 deletions

View File

@ -59,6 +59,9 @@ def shell(parser, xml_parent, data):
def trigger_builds(parser, xml_parent, data):
"""yaml: trigger-builds
Trigger builds of other jobs.
Requires the Jenkins `Parameterized Trigger Plugin.
<https://wiki.jenkins-ci.org/display/JENKINS/
Parameterized+Trigger+Plugin>`_
:arg str project: the Jenkins project to trigger
:arg str predefined-parameters:
@ -103,6 +106,19 @@ def trigger_builds(parser, xml_parent, data):
def builders_from(parser, xml_parent, data):
"""yaml: builders-from
Use builders from another project.
Requires the Jenkins `Template Project Plugin.
<https://wiki.jenkins-ci.org/display/JENKINS/Template+Project+Plugin>`_
:arg str projectName: the name of the other project
Example::
builders:
- builders-from:
- project: "base-build"
"""
pbs = XML.SubElement(xml_parent,
'hudson.plugins.templateproject.ProxyBuilder')
XML.SubElement(pbs, 'projectName').text = data

View File

@ -333,14 +333,6 @@ def violations(parser, xml_parent, data):
XML.SubElement(config, 'encoding').text = 'default'
# Jenkins Job module for generic scp publishing
# To use you add the following into your YAML:
# publish:
# site: 'openstack-ci.openstack.org'
# source: 'doc/build/html/**/*'
# target_path: 'ci/zuul'
# keep_heirarchy: 'true'
def scp(parser, xml_parent, data):
"""yaml: scp
Upload files via SCP
@ -389,9 +381,22 @@ def scp(parser, xml_parent, data):
def pipeline(parser, xml_parent, data):
"""yaml: pipeline
Upload files via SCP
Requires the Jenkins `Build Pipeline Plugin.
<https://wiki.jenkins-ci.org/display/JENKINS/Build+Pipeline+Plugin>`_
:arg str downstreamProjectNames: name of the downstream projects
Example::
publishers:
- pipleline:
downstreamProjectNames: 'deploy'
"""
pippub = XML.SubElement(xml_parent,
'au.com.centrumsystems.hudson.plugin.'
'buildpipeline.trigger.BuildPipelineTrigger')
'au.com.centrumsystems.hudson.plugin.'
'buildpipeline.trigger.BuildPipelineTrigger')
XML.SubElement(pippub, 'downstreamProjectNames').text = data