zuul-sphinx/doc/source/example-jobs.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

37 lines
556 B
ReStructuredText

Example Jobs
============
Jobs
----
.. job:: example
This is an example job.
.. jobvar:: foo
This is a variable used by this job.
.. jobvar:: bar
:default: zero
This is a sub key.
.. jobvar:: items
:type: list
This variable is a list.
.. jobvar:: baz
This is an item in a list.
.. job:: example
:variant: stable
This is a variant of :job:`example` which runs on stable branches.
This is a job role: :job:`example`
This is a job variable role: :jobvar:`example.foo.bar`