|
| 1 | +--- |
| 2 | +name: Release |
| 3 | +about: Checklist and communication channel for PyPI and GitHub release |
| 4 | +title: "Ready for <version-number> PyPI/GitHub release" |
| 5 | +labels: "release" |
| 6 | +assignees: "" |
| 7 | +--- |
| 8 | + |
| 9 | +### PyPI/GitHub release checklist: |
| 10 | + |
| 11 | +- [ ] All PRs/issues attached to the release are merged. |
| 12 | +- [ ] All the badges on the README are passing. |
| 13 | +- [ ] 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 on the website (e.g., diffpy.org) are updated. |
| 17 | +- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version. |
| 18 | +- [ ] Grammar and writing quality are checked (no typos). |
| 19 | + |
| 20 | +Please mention @sbillinge here when you are ready for PyPI/GitHub release. Include any additional comments necessary, such as |
| 21 | +version information and details about the pre-release here: |
| 22 | + |
| 23 | +### conda-forge release checklist: |
| 24 | + |
| 25 | +<!-- After @sbillinge releases the PyPI package, please check the following when creating a PR for conda-forge release.--> |
| 26 | + |
| 27 | +- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock. |
| 28 | +- [ ] All relevant issues in the feedstock are addressed in the release PR. |
| 29 | + |
| 30 | +### Post-release checklist |
| 31 | + |
| 32 | +<!-- Before closing this issue, please complete the following: --> |
| 33 | + |
| 34 | +- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments. |
| 35 | +- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures. |
0 commit comments