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

Merge PR #52 by @scop

Browse source 
This change adjusts the example secret names in README to be uppercase
and renames them to communicate better that it's supposed to be a PyPI
API token.
This commit is contained in:
Sviatoslav Sydorenko 2020-12-13 23:44:03 +01:00
commit f91f98d65e
No known key found for this signature in database
GPG key ID: 9345E8FEA89CA455
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -16,7 +16,7 @@ To use the action add the following step to your workflow file (e.g.
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_password }}
password: ${{ secrets.PYPI_API_TOKEN }}
```
> **Pro tip**: instead of using branch pointers, like `master`, pin versions of
@ -41,13 +41,13 @@ So the full step would look like:
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_password }}
password: ${{ secrets.PYPI_API_TOKEN }}
```
The example above uses the new [API token][PyPI 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
The secret used in `${{ secrets.PYPI_API_TOKEN }}` needs to be created on the
settings page of your project on GitHub. See [Creating & using secrets].
@ -81,7 +81,7 @@ The action invocation in this case would look like:
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.test_pypi_password }}
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
repository_url: https://test.pypi.org/legacy/
```
@ -96,7 +96,7 @@ would now look like:
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_password }}
password: ${{ secrets.PYPI_API_TOKEN }}
packages_dir: custom-dir/
```