actions/pypi-publish
1
0
Fork 0
mirror of https://github.com/pypa/gh-action-pypi-publish.git synced 2024-11-25 10:01:02 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use PYPI_API_TOKEN instead of pypi_password as secret name in examples

Browse source 
GitHub secrets are customarily spelled in uppercase, and in PyPI terms
we're dealing with API tokens here, not passwords.
This commit is contained in:
Ville Skyttä 2020-12-12 18:07:19 +02:00
parent 54b39fb937
commit 4425980a33
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 uses: pypa/gh-action-pypi-publish@master
with: with:
user: __token__ user: __token__
password: ${{ secrets.pypi_password }} password: ${{ secrets.PYPI_API_TOKEN }}
``` ```
> **Pro tip**: instead of using branch pointers, like `master`, pin versions of > **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 uses: pypa/gh-action-pypi-publish@master
with: with:
user: __token__ user: __token__
password: ${{ secrets.pypi_password }} password: ${{ secrets.PYPI_API_TOKEN }}
``` ```
The example above uses the new [API token][PyPI API token] feature of The example above uses the new [API token][PyPI API token] feature of
PyPI, which is recommended to restrict the access the action has. 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]. 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 uses: pypa/gh-action-pypi-publish@master
with: with:
user: __token__ user: __token__
password: ${{ secrets.test_pypi_password }} password: ${{ secrets.TEST_PYPI_API_TOKEN }}
repository_url: https://test.pypi.org/legacy/ repository_url: https://test.pypi.org/legacy/
``` ```
@ -96,7 +96,7 @@ would now look like:
uses: pypa/gh-action-pypi-publish@master uses: pypa/gh-action-pypi-publish@master
with: with:
user: __token__ user: __token__
password: ${{ secrets.pypi_password }} password: ${{ secrets.PYPI_API_TOKEN }}
packages_dir: custom-dir/ packages_dir: custom-dir/
``` ```