Skip to content

Commit 3588f57

Browse files
authored
Add New release checklist BG standard: python -m build and twine check dist/*
1 parent 08de7c9 commit 3588f57

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,31 @@ assignees: ""
1212
- [ ] All the badges on the README are passing.
1313
- [ ] License information is verified as correct. If you are unsure, please comment below.
1414
- [ ] 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 on the website (e.g., diffpy.org) are updated.
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.
1717
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
1818
- [ ] Grammar and writing quality are checked (no typos).
19+
- [ ] 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.
1920

2021
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:
2122

22-
### PyPI/GitHub full-release preparation checklist:
23-
- [ ] Create a new conda environment and install the rc from pypi (`pip install <package-name>=??`)
24-
- [ ] License information at Pypi is verified as correct.
25-
- [ ] Docs deployed successfully to `<package-name>.github.io`
26-
- [ ] Successfully run all tests, tutorial examples or do functional testing
23+
### PyPI/GitHub full-release preparation checklist:
2724

28-
Please let @sbillinge know that all checks are done and package is ready for full release.
25+
- [ ] Create a new conda environment and install the rc from PyPI (`pip install <package-name>==??`)
26+
- [ ] License information on PyPI is correct.
27+
- [ ] Docs are deployed successfully to `https://www.diffpy.org/<package-name>`.
28+
- [ ] Successfully run all tests, tutorial examples or do functional testing.
29+
30+
Please let @sbillinge know that all checks are done and the package is ready for full release.
2931

3032
### conda-forge release preparation checklist:
3133

3234
<!-- After @sbillinge releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
3335

34-
- [ ] Ensure that the full release has appeared on Pypi successfully
36+
- [ ] Ensure that the full release has appeared on PyPI successfully.
3537
- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock.
36-
- [ ] Close any open issues on the feedstock. Reach out to @bobleesj if you have questions
37-
- [ ] let @sbillinge and @bobleesj when this is ready
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.
3840

3941
### Post-release checklist
4042

0 commit comments

Comments
 (0)