zuul/zuul-jobs
Code Issues Proposed changes

upload-pypi: support API token upload

Browse Source 
Support an api_token argument.  Accounts that have two-factor auth
will at some point require using API tokens to upload.

Change-Id: Id0c47d088d6e8febbae3c96caecc81ebe247754e
This commit is contained in:
Ian Wienand 2022-07-13 10:26:20 +10:00
parent 8e9d9c2f7d
commit 2c58a8ceed
4 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
roles/upload-pypi/README.rst
View File

@ -8,9 +8,16 @@ Upload python packages to PyPI
server as well as the authentication information needed. It is
expected that this argument comes from a `Secret`.
.. zuul:rolevar:: api_token
:default: None
PyPi API token to use for upload. If specified, ``username`` and
``password`` should be empty.
.. zuul:rolevar:: username
Username to use to log in to PyPI.
Username to use to log in to PyPI. `Note` PyPi reccommends using
two-factor auth and generating an API token for uploading.
.. zuul:rolevar:: password

7
roles/upload-pypi/tasks/main.yaml
View File

@ -1,3 +1,10 @@
- name: Validate password/token combo
fail:
msg: 'Specify either username/password or api_token'
when: >
(pypi_info.api_token is defined) and
((pypi_info.username is defined) or (pypi_info.password is defined))
- name: Create .pypirc configuration file tempfile
tempfile:
state: file

4
roles/upload-pypi/templates/.pypirc.j2
View File

@ -6,5 +6,5 @@ index-servers=
{% if pypi_repository_url %}
repository:{{ pypi_repository_url }}
{% endif %}
username:{{ pypi_info.username }}
password:{{ pypi_info.password }}
username:{{ '__token__' if (pypi_info.api_token is defined) else pypi_info.username }}
password:{{ pypi_info.api_token if (pypi_info.api_token is defined) else pypi_info.password }}

5
zuul.d/python-jobs.yaml
View File

@ -338,8 +338,9 @@
description: |
Generate and upload a python source tarball and binary wheel
Requires a variable ``pypi_info`` be set which is a dict containing
at least a ``username`` and ``password`` attribute.
Requires a variable ``pypi_info`` be set which is a dict
containing authentication values. See
`<https://zuul-ci.org/docs/zuul-jobs/python-roles.html#role-upload-pypi>`__
post-run: playbooks/python/upload-pypi.yaml
- job: