Skip to content

Commit 8f96af4

Browse files
authored
Merge pull request #15 from executablebooks/readme-update
Revise PyPi publishing instructions in README
2 parents 994cb21 + e5b89ea commit 8f96af4

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,10 @@ tox -e py310-hook
5151

5252
## Publish to PyPi
5353

54-
Either use flit directly:
54+
Publishing is handled using a trusted action as part of the release process. Authentication is via OIDC
55+
and should be triggered by creating a release with a tag equal to the version, e.g. `v0.0.1`.
5556

56-
```bash
57-
pip install flit
58-
flit publish
59-
```
60-
61-
or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.
62-
63-
Note, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.
57+
Maintainer note: this is configured in PyPI as a trusted repository.
6458

6559
[ci-badge]: https://github.com/gaige/mdformat-footnote/workflows/CI/badge.svg?branch=master
6660
[ci-link]: https://github.com/gaige/mdformat-footnote/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush

0 commit comments

Comments
 (0)