Skip to content

Commit f91f98d

Browse files
committed
Merge PR #52 by @scop
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.
2 parents 54b39fb + 4425980 commit f91f98d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To use the action add the following step to your workflow file (e.g.
1616
uses: pypa/gh-action-pypi-publish@master
1717
with:
1818
user: __token__
19-
password: ${{ secrets.pypi_password }}
19+
password: ${{ secrets.PYPI_API_TOKEN }}
2020
```
2121
2222
> **Pro tip**: instead of using branch pointers, like `master`, pin versions of
@@ -41,13 +41,13 @@ So the full step would look like:
4141
uses: pypa/gh-action-pypi-publish@master
4242
with:
4343
user: __token__
44-
password: ${{ secrets.pypi_password }}
44+
password: ${{ secrets.PYPI_API_TOKEN }}
4545
```
4646

4747
The example above uses the new [API token][PyPI API token] feature of
4848
PyPI, which is recommended to restrict the access the action has.
4949

50-
The secret used in `${{ secrets.pypi_password }}` needs to be created on the
50+
The secret used in `${{ secrets.PYPI_API_TOKEN }}` needs to be created on the
5151
settings page of your project on GitHub. See [Creating & using secrets].
5252

5353

@@ -81,7 +81,7 @@ The action invocation in this case would look like:
8181
uses: pypa/gh-action-pypi-publish@master
8282
with:
8383
user: __token__
84-
password: ${{ secrets.test_pypi_password }}
84+
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
8585
repository_url: https://test.pypi.org/legacy/
8686
```
8787

@@ -96,7 +96,7 @@ would now look like:
9696
uses: pypa/gh-action-pypi-publish@master
9797
with:
9898
user: __token__
99-
password: ${{ secrets.pypi_password }}
99+
password: ${{ secrets.PYPI_API_TOKEN }}
100100
packages_dir: custom-dir/
101101
```
102102

0 commit comments

Comments
 (0)