Skip to content

Commit 27d7045

Browse files
committed
release_checklist.md
1 parent d4c8f5f commit 27d7045

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,33 @@ assignees: ""
1111
- [ ] All PRs/issues attached to the release are merged.
1212
- [ ] All the badges on the README are passing.
1313
- [ ] License information is verified as correct. If you are unsure, please comment below.
14-
- [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are
15-
missing), tutorials, and other human-written text is up-to-date with any changes in the code.
16-
- [ ] Installation instructions in the README, documentation, and the website (e.g., diffpy.org) are updated.
14+
- [ ] Locally rendered documentation contains all appropriate pages, tutorials, and other human-written text is up-to-date with any changes in the code.
15+
- [ ] All API references are included. To check this, run `conda install scikit-package` and then `package build api-doc`. Review any edits made by rerendering the docs locally.
16+
- [ ] Installation instructions in the README, documentation, and the website are updated.
1717
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
1818
- [ ] Grammar and writing quality are checked (no typos).
1919
- [ ] Install `pip install build twine`, run `python -m build` and `twine check dist/*` to ensure that the package can be built and is correctly formatted for PyPI release.
20+
- [ ] Dispatch matrix testing to test the release on all Python versions and systems. If you do not have permission to run this workflow, tag the maintainer and say `@maintainer, please dispatch matrix testing workflow`.
2021

21-
Please mention @sbillinge here when you are ready for PyPI/GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here:
22+
Please tag the maintainer (e.g., @username) in the comment here when you are ready for the PyPI/GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here:
2223

2324
### PyPI/GitHub full-release preparation checklist:
2425

2526
- [ ] Create a new conda environment and install the rc from PyPI (`pip install <package-name>==??`)
2627
- [ ] License information on PyPI is correct.
27-
- [ ] Docs are deployed successfully to `https://www.diffpy.org/<package-name>`.
28+
- [ ] Docs are deployed successfully to `https://<github-username-or-orgname>/<package-name>`.
2829
- [ ] Successfully run all tests, tutorial examples or do functional testing.
2930

30-
Please let @sbillinge know that all checks are done and the package is ready for full release.
31+
Please let the maintainer know that all checks are done and the package is ready for full release.
3132

3233
### conda-forge release preparation checklist:
3334

34-
<!-- After @sbillinge releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
35+
<!-- After the maintainer releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
3536

3637
- [ ] Ensure that the full release has appeared on PyPI successfully.
37-
- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock.
38-
- [ ] Close any open issues on the feedstock. Reach out to @bobleesj if you have questions.
39-
- [ ] Tag @sbillinge and @bobleesj for conda-forge release.
38+
- [ ] New package dependencies listed in `conda.txt` and `tests.txt` are added to `meta.yaml` in the feedstock.
39+
- [ ] Close any open issues on the feedstock. Reach out to the maintainer if you have questions.
40+
- [ ] Tag the maintainer for conda-forge release.
4041

4142
### Post-release checklist
4243

0 commit comments

Comments
 (0)