Skip to content

Commit 1c4ba7c

Browse files
committed
how to make a release in PR template
1 parent 3217bf4 commit 1c4ba7c

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

.github/pull_request_template.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,29 @@
77
- [ ] This comment contains a description of changes (with reason)
88
- [ ] Referenced issue is linked
99
- [ ] If you've fixed a bug or added code that should be tested, add tests!
10-
- [ ] Documentation in `docs` is updated
10+
- [ ] Documentation in `docs` is updated. If you've created a new file, add it to the API documentation pages.
11+
12+
<!-- Only applies to PRs for a new version release, delete the lines that don't apply -->
13+
14+
**Version release checklist**
15+
16+
- [ ] Update the version in pyproject.toml
17+
- [ ] Update version/release in docs/conf.py
18+
- [ ] Run ‚poetry update‘ to get the latest package versions. This will update the poetry.lock file
19+
- [ ] Run ‚poetry export --without-hashes --without development -f requirements.txt -o requirements.txt‘ to update the requirements.txt file
20+
- [ ] (If one of the sphinx packages has been updated, you also need to update docs/requirements.txt)
21+
- [ ] (If poetry itself was updated, update that in the Dockerfile)
22+
- [ ] If you updated the python version:
23+
- [ ] Update the Dockerfile so that it always runs on the latest python version. Watch out: the ‚builder‘ is the full python, the ‚runtime‘ is a slim python build.
24+
- [ ] Update the python version in .github/workflows/: run_tests.yml, build_package.yml, publish_docs.yml, python-package.yml
25+
- [ ] Update the python version in noxfile.py
26+
- [ ] Update the documentation: contributing.rst, installation.rst
27+
28+
Then,
29+
30+
1. Open a PR from development to main with these changes.
31+
2. Wait for a review and merge.
32+
3. Create a new release on GitHub with the version number. Update the release notes with the changes made in this version.
1133

1234
**Description of changes**
1335

0 commit comments

Comments
 (0)