Skip to content
Open
Changes from all commits
Commits
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
10 changes: 6 additions & 4 deletions docs/template_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,17 +205,19 @@ There you can see the execution history, logs, and (re-)trigger workflows manual

#### Configuring the Github workflow

Tags adhering to `"*.*.*"` that are pushed to the `main` branch will trigger the release Github workflow that automatically builds and uploads the Python package to [PyPI][].
Tags adhering to `"*.*.*"` that are pushed to the `main` branch and subsequently [released](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) will trigger the release Github workflow that automatically builds and uploads the Python package to [PyPI](https://pypi.org).

For this to work, you'll need to setup GitHub as a [trusted publisher][] on PyPI.
To set this up, login to [PyPI][], and proceed depending on whether you already have your project on there or not:
For this to work, you'll need to setup GitHub as a [trusted publisher](https://docs.pypi.org/trusted-publishers/) on PyPI.
To set this up, login to [PyPI](https://pypi.org), and proceed depending on whether you already have your project on there or not:
- If yes, navigate to the project. In the left sidebar, choose "Publishing", then proceed to add the repository details.
- If not, go to your [PyPI publishing settings][] and fill out the “Add a new pending publisher” form.
- If not, go to your PyPI publishing settings and fill out the “Add a new pending publisher” form.

The "Workflow name" needs to bet set to `release.yaml`.
In most cases, you can leave the "Environment name" empty.
For more details, please refer to the official [PyPI guide for setting up trusted publishing][pypi-trusted-publishing-guide].

If you added a new pending publisher to set up your project, the project will be published only once you release your package for the first time (see above).

(pre-commit)=

### Pre-commit checks
Expand Down
Loading