Skip to content

Commit 4c17467

Browse files
Update instance repo from cookiecutter template
1 parent 122f3e6 commit 4c17467

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

.cruft.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse",
3-
"commit": "ad0332dbfa444deed52a054a02e2378cbb5566db",
3+
"commit": "4955200eefb87309216cf23f46dfb04c4e61b133",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {
@@ -36,7 +36,7 @@
3636
"trim_blocks": true
3737
},
3838
"_template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse",
39-
"_commit": "ad0332dbfa444deed52a054a02e2378cbb5566db"
39+
"_commit": "4955200eefb87309216cf23f46dfb04c4e61b133"
4040
}
4141
},
4242
"directory": null

docs/template_usage.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,11 @@ There you can see the execution history, logs, and (re-)trigger workflows manual
144144
[Github Actions]: https://github.com/features/actions
145145
[twine]: https://github.com/pypa/twine
146146

147-
### Automating PyPI released using GitHub actions
147+
(automating-the-pypi-release-using-github-actions)=
148+
(automating-pypi-released-using-github-actions)=
149+
(configuring-the-github-workflow)=
148150

149-
#### Configuring the Github workflow
151+
### Automating the PyPI release using GitHub actions
150152

151153
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][].
152154

@@ -155,8 +157,9 @@ To set this up, login to [PyPI][], and proceed depending on whether you already
155157
- If yes, navigate to the project. In the left sidebar, choose "Publishing", then proceed to add the repository details.
156158
- If not, go to your [PyPI publishing settings][] and fill out the “Add a new pending publisher” form.
157159

160+
Enter everything *exactly* as it is displayed on GitHub (i.e. use the correct casing for your repository name).
158161
The "Workflow name" needs to bet set to `release.yaml`.
159-
In most cases, you can leave the "Environment name" empty.
162+
Set "Environment name" to “pypi” to match `environment: pypi` in `.github/workflows/release.yaml`.
160163
For more details, please refer to the official [PyPI guide for setting up trusted publishing][trusted publisher].
161164

162165
[pypi-trusted-publishing-guide]: https://docs.pypi.org/trusted-publishers/adding-a-publisher/

0 commit comments

Comments
 (0)