zuul-sphinx/doc/source/examples.rst
James E. Blair ad1188ba7f Add jobvar and rolevar directives
Jobs and Roles frequently have the same variable names, so use
create unique directives and roles for each so that they are
easy to disambiguate.

This lets us say :jobvar:`tox.environment` rather than
:var:`job-tox.environment` which seems a bit arbitrary.

Change-Id: I9d72d11bfdb700037a6a08f92a2dbfa95ee519ad
2017-08-11 15:04:23 -07:00

1005 B

Examples

Configuration Attributes

example-attr

This is an example configuration attribute.

foo

A sub attribute.

bar

An attribute value.

baz

Another attribute value.

This is an attribute role: example-attr.foo

This is an attribute value role: example-attr.foo.bar

Job Variables

example-variable

This is an example variable.

foo

This is a variable.

bar

This is a sub key.

items

This variable is a list.

baz

This is an item in a list.

This is a variable role: example-variable.items.baz

Statistics

example-stat

This is an example statistic.

foo

A sub stat.

This is a statistics role: example-stat.foo