Anatoli Babenia
52945e1668
checkout@v2 -> v3 upload/download-artifact@v2 -> v3 python-setup@v2 -> v3 pypa/gh-action-pypi-publish@1.4.2 -> v1.5.0 Python latest is v4, but it breaks working with default Python version https://github.com/actions/setup-python/issues/421
98 lines
3.5 KiB
Markdown
98 lines
3.5 KiB
Markdown
---
|
|
title: Delivering to PyPI
|
|
---
|
|
|
|
After you've built your wheels, you'll probably want to deliver them to PyPI.
|
|
|
|
## Manual method
|
|
|
|
On your development machine, install [pipx](https://pypa.github.io/pipx/) and do the following:
|
|
|
|
```bash
|
|
# Either download the SDist from your CI, or make it:
|
|
# Clear out your 'dist' folder.
|
|
rm -rf dist
|
|
# Make a source distribution
|
|
pipx run build --sdist
|
|
|
|
# 🏃🏻
|
|
# Go and download your wheel files from wherever you put them. e.g. your CI
|
|
# provider can be configured to store them for you. Put them all into the
|
|
# 'dist' folder.
|
|
|
|
# Upload using 'twine' (you may need to 'pip install twine')
|
|
pipx run twine upload dist/*
|
|
```
|
|
|
|
## Automatic method
|
|
|
|
If you don't need much control over the release of a package, you can set up
|
|
cibuildwheel to deliver the wheels straight to PyPI. You just need to bump the
|
|
version and tag it.
|
|
|
|
### Generic instructions
|
|
|
|
Make your SDist with the [build](https://github.com/pypa/build) tool, and your wheels with cibuildwheel. If you can make the files available as
|
|
downloadable artifacts, this make testing before releases easier (depending on your CI provider's options). The "publish" job/step should collect the
|
|
files, and then run `twine upload <paths>` (possibly via [pipx](https://github.com/pypa/pipx)); this should only happen on tags or "releases".
|
|
|
|
### GitHub Actions
|
|
|
|
GitHub actions has pipx in all the runners as a supported package manager, as
|
|
well as several useful actions. Alongside your existing job(s) that runs cibuildwheel to make wheels, you will probably want to build an SDist:
|
|
|
|
```yaml
|
|
make_sdist:
|
|
name: Make SDist
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0 # Optional, use if you use setuptools_scm
|
|
submodules: true # Optional, use if you have submodules
|
|
|
|
- name: Build SDist
|
|
run: pipx run build --sdist
|
|
|
|
- uses: actions/upload-artifact@v3
|
|
with:
|
|
path: dist/*.tar.gz
|
|
```
|
|
|
|
Then, you need to publish the artifacts that the previous jobs have built. This final job should run only on release or tag, depending on your preference. It gathers the artifacts from the sdist and wheel jobs and uploads them to PyPI.
|
|
|
|
This requires a [PyPI upload token](https://pypi.org/manage/account/token/), stored in your [GitHub repo's secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) as `pypi_password`.
|
|
|
|
```yaml
|
|
upload_all:
|
|
needs: [build_wheels, make_sdist]
|
|
runs-on: ubuntu-latest
|
|
if: github.event_name == 'release' && github.event.action == 'published'
|
|
steps:
|
|
- uses: actions/download-artifact@v3
|
|
with:
|
|
name: artifact
|
|
path: dist
|
|
|
|
- uses: pypa/gh-action-pypi-publish@v1.5.0
|
|
with:
|
|
user: __token__
|
|
password: ${{ secrets.pypi_password }}
|
|
```
|
|
|
|
You should use dependabot to keep the publish action up to date. In the above
|
|
example, the same name (the default, "artifact" is used for all upload-artifact
|
|
runs, so we can just download all of the in one step into a common directory.
|
|
|
|
See
|
|
[`examples/github-deploy.yml`](https://github.com/pypa/cibuildwheel/blob/main/examples/github-deploy.yml)
|
|
for an example configuration that automatically upload wheels to PyPI. Also see
|
|
[scikit-hep.org/developer/gha_wheels](https://scikit-hep.org/developer/gha_wheels)
|
|
for a complete guide.
|
|
|
|
### TravisCI
|
|
|
|
See
|
|
[`examples/travis-ci-deploy.yml`](https://github.com/pypa/cibuildwheel/blob/main/examples/travis-ci-deploy.yml)
|
|
for an example configuration.
|