From 4e7100a729389faf5eef2964f89360b658ca19f5 Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Sun, 19 Oct 2025 05:20:12 -0400 Subject: [PATCH 1/4] Revise PyPi publishing instructions in README Updated the publishing instructions for PyPi to clarify the use of GitHub Actions and OIDC authentication. --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 22ae31c..1914dc8 100644 --- a/README.md +++ b/README.md @@ -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. Authetication is via OIDC +and should be triggered through 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 From ad2ca019ddaa7f5572425489d79f0ae9acf42189 Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Sun, 19 Oct 2025 05:21:08 -0400 Subject: [PATCH 2/4] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1914dc8..ebb1022 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ tox -e py310-hook Publishing is handled using a trusted action as part of the release process. Authetication is via OIDC and should be triggered through by creating a release with a tag equal to the version, e.g. `v0.0.1`. -Maintainer note: this is configured in PyPi as a trusted repository. +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 From c9f88bdfaca0dd0649599ae7a3f39b03f79211d3 Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Sun, 19 Oct 2025 05:21:33 -0400 Subject: [PATCH 3/4] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ebb1022..4720d92 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ tox -e py310-hook ## Publish to PyPi Publishing is handled using a trusted action as part of the release process. Authetication is via OIDC -and should be triggered through by creating a release with a tag equal to the version, e.g. `v0.0.1`. +and should be triggered by creating a release with a tag equal to the version, e.g. `v0.0.1`. Maintainer note: this is configured in PyPI as a trusted repository. From e5b89ea712fde2834b659fe60bd6febfeccd8e5c Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Sun, 19 Oct 2025 05:21:44 -0400 Subject: [PATCH 4/4] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4720d92..8f37780 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ tox -e py310-hook ## Publish to PyPi -Publishing is handled using a trusted action as part of the release process. Authetication is via OIDC +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`. Maintainer note: this is configured in PyPI as a trusted repository.