You can use build properties in ShellCommands by using the
WithProperties wrapper when setting the arguments of
the ShellCommand. This interpolates the named build properties
into the generated shell command. Most step parameters accept
WithProperties. Please file bugs for any parameters which
from buildbot.steps.shell import ShellCommand from buildbot.process.properties import WithProperties f.addStep(ShellCommand( command=["tar", "czf", WithProperties("build-%s.tar.gz", "revision"), "source"]))
If this BuildStep were used in a tree obtained from Subversion, it would create a tarball with a name like build-1234.tar.gz.
WithProperties function does
interpolation, using strings obtained by calling
build.getProperty(propname). Note that for every
%d, etc), you must have exactly one additional argument to
indicate which build property you want to insert.
You can also use python dictionary-style string interpolation by using
%(propname)s syntax. In this form, the property name goes
in the parentheses, and WithProperties takes no additional
f.addStep(ShellCommand( command=["tar", "czf", WithProperties("build-%(revision)s.tar.gz"), "source"]))
Don't forget the extra “s” after the closing parenthesis! This is the cause of many confusing errors.
The dictionary-style interpolation supports a number of more advanced syntaxes, too.
propnameexists, substitute its value; otherwise, substitute
replacementmay be empty (
propname:-replacement, but only substitutes the value of property
propnameif it is something Python regards as "true". Python considers
None, 0, empty lists, and the empty string to be false, so such values will be replaced by
replacement; otherwise, substitute an empty string.
Although these are similar to shell substitutions, no other
substitutions are currently supported, and
replacement in the
above cannot contain more substitutions.
Note: like python, you can either do positional-argument interpolation
or keyword-argument interpolation, not both. Thus you cannot use
a string like