zuul/zuul-jobs
Code Issues Proposed changes

Document twine_executable

Browse Source 
Change Ia06218a830b5d44f04e0f10e0444be2cf9ad682e missed to document
the variable, add it.

Change-Id: Ibbe4c40f8a4ea26a16e0a25a788636621e062902
This commit is contained in:
Andreas Jaeger 2020-06-01 12:20:42 +02:00
parent 76eda39210
commit e6396cca48
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
roles/ensure-twine/README.rst
View File

@ -7,3 +7,17 @@ Ensure twine is installed.
The python interpreter to use to install twine if it is not already
installed. Set it to "python3" to use python 3, for example.
**Output Variables**
.. zuul:rolevar:: twine_excutable
:default: twine
After running this role, ``twine_executable`` will be set as the path
to a valid ``twine``.
At role runtime, look for an existing ``twine`` at this specific
path. Note the default (``twine``) effectively means to find tox in
the current ``$PATH``. For example, if your base image
pre-installs twine in an out-of-path environment, set this so the
role does not attempt to install the user version.