actions/pypi-publish
1
0
Fork 0
mirror of https://github.com/pypa/gh-action-pypi-publish.git synced 2024-09-13 08:07:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
The blessed :octocat: GitHub Action, for publishing your 📦 distribution files to PyPI: https://github.com/marketplace/actions/pypi-publish
7 commits 11 branches 39 tags 784 KiB
Python 62.6%
Shell 32.9%
Dockerfile 4.5%
Find a file
Sviatoslav Sydorenko 470267472e
Add SECURITY text
2019-05-26 17:50:09 +02:00
.github Add SECURITY text 2019-05-26 17:50:09 +02:00
.gitignore Initial commit 2019-03-27 19:44:44 +01:00
Dockerfile 📄🐳 Relicense the repo to BSD 3-clause 2019-03-29 23:21:12 +01:00
LICENSE.md 📄🐳 Relicense the repo to BSD 3-clause 2019-03-29 23:21:12 +01:00
README.md 📄 Update the license mention in README 2019-03-29 23:48:49 +01:00

README.md

PyPI publish GitHub Action

This action allows you to upload your Python distribution package to PYPI.

Usage

To use the action simply add the following lines in the end of your .github/main.workflow.

action "Upload Python dist to PyPI" {
  uses = "re-actors/pypi-action@master"
  env = {
    TWINE_USERNAME = "f'{your_project}-bot'"
  }
  secrets = ["TWINE_PASSWORD"]
}

N.B. Use a valid tag, or branch, or commit SHA instead of master to pin the action to use a specific version of it.

Environment Variables and Secrets

  • TWINE_USERNAME: set this one to the username used to authenticate against PyPI. It is recommended to have a separate user account like f'{your_project}-bot' having the lowest privileges possible on your target dist page.
  • TWINE_PASSWORD: it's a password for the account used in TWINE_USERNAME env var. ATTENTION! WARNING! When adding this value to the Action node in your workflow, use SECRETS, not normal env vars.

License

The Dockerfile and associated scripts and documentation in this project are released under the BSD 3-clause license.