Skip to content

Revise PyPi publishing instructions in README #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 19, 2025
Merged

Revise PyPi publishing instructions in README #15

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e7100a
Revise PyPi publishing instructions in README
gaige Oct 19, 2025
ad2ca01
Update README.md
gaige Oct 19, 2025
c9f88bd
Update README.md
gaige Oct 19, 2025
e5b89ea
Update README.md
gaige Oct 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,10 @@ tox -e py310-hook

## Publish to PyPi

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

```bash
pip install flit
flit publish
```

or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.

Note, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.
Maintainer note: this is configured in PyPI as a trusted repository.

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