Skip to content

Commit 4372cb5

Browse files
committed
README: replace OIDC with "trusted publishing"
Also updates the link to reference the public documentation for trusted publishing, rather than the PyPI short help section (which also needs to be updated). Signed-off-by: William Woodruff <[email protected]>
1 parent 69efb8c commit 4372cb5

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,33 +65,33 @@ settings page of your project on GitHub. See [Creating & using secrets].
6565
### Publishing with OpenID Connect
6666

6767
> **IMPORTANT**: This functionality is in beta, and will not work for you
68-
> unless you're a member of the PyPI OIDC beta testers' group. For more
69-
> information, see [warehouse#12965].
68+
> unless you're a member of the PyPI trusted publishing beta testers' group.
69+
> For more information, see [warehouse#12965].
7070

71-
This action supports PyPI's [OpenID Connect publishing]
71+
This action supports PyPI's [trusted publishing]
7272
implementation, which allows authentication to PyPI without a manually
7373
configured API token or username/password combination. To perform
74-
[OIDC publishing][OpenID Connect Publishing] with this action, your project's
75-
OIDC publisher must already be configured on PyPI.
74+
[trusted publishing] with this action, your project's
75+
publisher must already be configured on PyPI.
7676

77-
To enter the OIDC flow, configure this action's job with the `id-token: write`
78-
permission and **without** an explicit username or password:
77+
To enter the trusted publishing flow, configure this action's job with the
78+
`id-token: write` permission and **without** an explicit username or password:
7979

8080
```yaml
8181
jobs:
8282
pypi-publish:
8383
name: Upload release to PyPI
8484
runs-on: ubuntu-latest
8585
permissions:
86-
id-token: write # IMPORTANT: this permission is mandatory for OIDC publishing
86+
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
8787
steps:
8888
# retrieve your distributions here
8989
9090
- name: Publish package distributions to PyPI
9191
uses: pypa/gh-action-pypi-publish@release/v1
9292
```
9393

94-
Other indices that support OIDC publishing can also be used, like TestPyPI:
94+
Other indices that support trusted publishing can also be used, like TestPyPI:
9595

9696
```yaml
9797
- name: Publish package distributions to TestPyPI
@@ -268,4 +268,4 @@ https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direc
268268
https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
269269

270270
[warehouse#12965]: https://github.com/pypi/warehouse/issues/12965
271-
[OpenID Connect Publishing]: https://pypi.org/help/#openid-connect
271+
[trusted publishing]: https://docs.pypi.org/trusted-publishers/

0 commit comments

Comments
 (0)