zuul-jobs/roles/upload-pypi/README.rst
mhuin fa9cb2f468 upload-pypi: add option to register packages
When uploading packages to a devPI instance, the role fails if
the packages are not registered first. Since this is not required
on PyPI, this adds the "pypi_register_first" option to the role
so that users can choose to do so.

Change-Id: I2b50362e485175d51840e49ffc09a734b44ec85d
2019-01-08 07:49:43 +00:00

44 lines
1.0 KiB
ReStructuredText

Upload python packages to PyPI
**Role Variables**
.. zuul:rolevar:: pypi_info
Complex argument which contains the information about the PyPI
server as well as the authentication information needed. It is
expected that this argument comes from a `Secret`.
.. zuul:rolevar:: username
Username to use to log in to PyPI.
.. zuul:rolevar:: password
Password to use to log in to PyPI.
.. zuul:rolevar:: repository
:default: pypi
Name of the repository to upload to.
.. zuul:rolevar:: repository_url
:default: The built-in twine default for the production pypi.org service.
URL of the PyPI repostory.
.. zuul:rolevar:: pypi_path
:default: src/{{ zuul.project.canonical_name }}/dist
Path containing artifacts to upload.
.. zuul:rolevar:: pypi_twine_executable
:default: twine
Path to twine executable.
.. zuul:rolevar:: pypi_register_first
:default: false
Whether the role should register the package before uploading it. This may
be required when uploading for the first time to a devPI instance.