zuul/zuul-jobs
Code Issues Proposed changes

Merge "Document twine_executable"

Browse Source
This commit is contained in:
Zuul 2020-06-04 05:43:06 +00:00 committed by Gerrit Code Review
commit 1d4ef3e866
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.