The blessed :octocat: GitHub Action, for publishing your 📦 distribution files to PyPI: https://github.com/marketplace/actions/pypi-publish
actionsgithub-actiongithub-actionsgithub-actions-pythonhacktoberfestoidcpypa-guidepypipythonpython-packagingreleaserelease-automationrelease-helpersecretstestpypitwineuploadworkflowworkflow-automationworkflows
f3ebf87ba2 | ||
---|---|---|
.github | ||
.gitignore | ||
.yamllint | ||
Dockerfile | ||
LICENSE.md | ||
README.md | ||
action.yml | ||
twine-upload.sh |
README.md
PyPI publish GitHub Action
This action allows you to upload your Python distribution package to PyPI.
Usage
To use the action add the following step to your workflow file (e.g.:
.github/workflows/main.yml
)
- name: Publish a Python distribution to PyPI
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_password }}
A common use case is to upload packages only on a tagged commit, to do so add a filter to the step:
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
So the full step would look like:
- name: Publish package
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_password }}
The example above uses the new API token feature of PyPI, which is recommended to restrict the access the action has.
The secret used in ${{ secrets.pypi_password }}
needs to be created on the settings
page of your project on GitHub. See Creating & using secrets.
License
The Dockerfile and associated scripts and documentation in this project are released under the BSD 3-clause license.