Skip to content

Commit

Permalink
Use PYPI_API_TOKEN instead of pypi_password as secret name in examples
Browse files Browse the repository at this point in the history
GitHub secrets are customarily spelled in uppercase, and in PyPI terms
we're dealing with API tokens here, not passwords.
  • Loading branch information
scop committed Dec 12, 2020
1 parent 54b39fb commit 4425980
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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].


Expand Down Expand Up @@ -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/
```

Expand All @@ -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/
```

Expand Down

0 comments on commit 4425980

Please sign in to comment.