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: {{cookiecutter.package_name}}/README.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,4 +12,31 @@ source .venv/bin/activate
12
12
uv pip install {{cookiecutter.package_name}}
13
13
# Install Chromium browser binary required for playwright.
14
14
playwright install chromium
15
-
```
15
+
```
16
+
17
+
## Additional setup
18
+
19
+
### Code coverage
20
+
21
+
- Add a "CODECOV_TOKEN" secret (obtained from [here](https://app.codecov.io/gh/dzhang32/test_python_package/)) to your repo via `Settings` -> `Secrets and variables` -> `Actions`.
22
+
23
+
{% if cookiecutter.include_docs == 'y' %}
24
+
### Deploying docs to gh-pages
25
+
26
+
1. Go to your repository's `Settings` -> `Actions` -> `General`.
27
+
2. Scroll to `Workflow permissions` and allow GHA to have `Read and write permissions` so it can create/push to the `gh-pages` branch.
28
+
3. Go to `Settings` -> `Pages`.
29
+
4. Configure your repo to deploy from the root of `gh-pages` branch.
30
+
{% endif %}
31
+
32
+
{% if cookiecutter.include_pypi == 'y' %}
33
+
### Deploying to PyPI
34
+
35
+
- Go to your [PyPi publishing settings](https://pypi.org/manage/account/publishing/) and fill in the following details:
0 commit comments