Add inventory variables for checkouts
Add override_checkout to the inventory variables, along with the
final checkout used for individual projects.
This can aid certain jobs like devstack which need to alter their
behavior in complex ways based on the branch the user intends to
test.
Change-Id: I58d94330e18670052fcd2d92b67a1a091d9249e6
diff --git a/doc/source/user/jobs.rst b/doc/source/user/jobs.rst
index f65ee19..0639b8b 100644
--- a/doc/source/user/jobs.rst
+++ b/doc/source/user/jobs.rst
@@ -172,6 +172,12 @@
The git ref of the item. This will be the full path (e.g.,
`refs/heads/master` or `refs/changes/...`).
+ .. var:: override_checkout
+
+ If the job was configured to override the branch or tag checked
+ out, this will contain the specified value. Otherwise, it will
+ be null.
+
.. var:: pipeline
The name of the pipeline in which the job is being run.
@@ -252,6 +258,12 @@
A boolean indicating whether this project appears in the
:attr:`job.required-projects` list for this job.
+ .. var:: checkout
+
+ The branch or tag that Zuul checked out for this project.
+ This may be influenced by the branch or tag associated with
+ the item as well as the job configuration.
+
.. var:: _projects
:type: dict