diff --git a/.cruft.json b/.cruft.json index 9d44c3f..7147414 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse", - "commit": "1da1d71043735a63d87f13e16caf5d9b90b3ba56", + "commit": "f9922a80eb0508a0d5ca0c427adef45000d3d40c", "checkout": null, "context": { "cookiecutter": { @@ -36,7 +36,7 @@ "trim_blocks": true }, "_template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse", - "_commit": "1da1d71043735a63d87f13e16caf5d9b90b3ba56" + "_commit": "f9922a80eb0508a0d5ca0c427adef45000d3d40c" } }, "directory": null diff --git a/docs/template_usage.md b/docs/template_usage.md index 793a62c..09df61b 100644 --- a/docs/template_usage.md +++ b/docs/template_usage.md @@ -147,7 +147,8 @@ There you can see the execution history, logs, and (re-)trigger workflows manual ## Automating the PyPI release using GitHub actions -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][]. +Releases created via the [Github releases UI][github-releases] +will trigger the release Github workflow that automatically builds and uploads the Python package to [PyPI][]. 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: @@ -159,6 +160,10 @@ The "Workflow name" needs to bet set to `release.yaml`. Set "Environment name" to “pypi” to match `environment: pypi` in `.github/workflows/release.yaml`. For more details, please refer to the official [PyPI guide for setting up trusted publishing][trusted publisher]. +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). + +[github-releases]: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases [pypi-trusted-publishing-guide]: https://docs.pypi.org/trusted-publishers/adding-a-publisher/ [PyPI]: https://pypi.org/