|
| 1 | +--- |
| 2 | +name: Release |
| 3 | +about: Checklist and communication channel for GitHub and conda-forge release |
| 4 | +title: "Ready for <version-number> GitHub/conda-forge release" |
| 5 | +labels: "release" |
| 6 | +assignees: "" |
| 7 | +--- |
| 8 | + |
| 9 | +### GitHub rc-release preparation 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 and other human-written text is up-to-date with any changes in the code. |
| 15 | +- [ ] Installation instructions in the README, documentation, and the website are updated. |
| 16 | +- [ ] Grammar and writing quality are checked (no typos). |
| 17 | +- [ ] `FALLBACK_VERSION` in `site_scons/fallback_version.py` is updated to `<version-number>.post0`. Without this, the SCons build fails after tagging. |
| 18 | +- [ ] `scons test` passes locally with the latest conda-forge compilers and dependencies. |
| 19 | +- [ ] Dispatch matrix testing to test the release on all systems. If you do not have permission to run this workflow, tag the maintainer and say `@maintainer, please dispatch matrix testing workflow`. Matrix testing also runs automatically after a GitHub release is published, but it does not block the release, so check that it passes. |
| 20 | + |
| 21 | +Please tag the maintainer (e.g., @username) in the comment here when you are ready for the GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here: |
| 22 | + |
| 23 | +### GitHub full-release preparation checklist: |
| 24 | + |
| 25 | +- [ ] The rc GitHub release and its source tarball appear correctly on the releases page. |
| 26 | +- [ ] Docs are deployed successfully to `https://www.diffpy.org/libdiffpy`. |
| 27 | +- [ ] Successfully run all tests and do functional testing, e.g., with `diffpy.srreal` built against the rc. |
| 28 | + |
| 29 | +Please let the maintainer know that all checks are done and the package is ready for full release. |
| 30 | + |
| 31 | +### conda-forge release preparation checklist: |
| 32 | + |
| 33 | +<!-- After the maintainer releases on GitHub, please check the following when creating a PR for conda-forge release.--> |
| 34 | + |
| 35 | +- [ ] Ensure that the full release has appeared on GitHub successfully. |
| 36 | +- [ ] `version` and `sha256` of the GitHub source tarball are updated in `meta.yaml` in the feedstock. |
| 37 | +- [ ] New package dependencies listed in `build.txt`, `conda.txt` and `tests.txt` are added to `meta.yaml` in the feedstock. |
| 38 | +- [ ] `license_file` in `meta.yaml` points to `LICENSE.rst` (renamed from `LICENSE.txt`). |
| 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. |
| 41 | + |
| 42 | +### Post-release checklist |
| 43 | + |
| 44 | +<!-- Before closing this issue, please complete the following: --> |
| 45 | + |
| 46 | +- [ ] Install the released package from conda-forge and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments. |
| 47 | +- [ ] Documentation (README, API references, and websites) is deployed without broken links or missing figures. |
0 commit comments