You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/template_usage.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -205,17 +205,19 @@ There you can see the execution history, logs, and (re-)trigger workflows manual
205
205
206
206
#### Configuring the Github workflow
207
207
208
-
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][].
208
+
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).
209
209
210
-
For this to work, you'll need to setup GitHub as a [trusted publisher][] on PyPI.
211
-
To set this up, login to [PyPI][], and proceed depending on whether you already have your project on there or not:
210
+
For this to work, you'll need to setup GitHub as a [trusted publisher](https://docs.pypi.org/trusted-publishers/) on PyPI.
211
+
To set this up, login to [PyPI](https://pypi.org), and proceed depending on whether you already have your project on there or not:
212
212
- If yes, navigate to the project. In the left sidebar, choose "Publishing", then proceed to add the repository details.
213
-
- If not, go to your [PyPI publishing settings][] and fill out the “Add a new pending publisher” form.
213
+
- If not, go to your PyPI publishing settings and fill out the “Add a new pending publisher” form.
214
214
215
215
The "Workflow name" needs to bet set to `release.yaml`.
216
216
In most cases, you can leave the "Environment name" empty.
217
217
For more details, please refer to the official [PyPI guide for setting up trusted publishing][pypi-trusted-publishing-guide].
218
218
219
+
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).
0 commit comments