From c231a1c858706fb8d5e3778f63cca6cd52c135fb Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 13 Dec 2024 12:43:00 -0500 Subject: [PATCH 1/3] Update release_checklist.md to the latest --- .github/ISSUE_TEMPLATE/release_checklist.md | 25 +++++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 0f56027..11df804 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -6,26 +6,37 @@ labels: "release" assignees: "" --- -### PyPI/GitHub release checklist: +### PyPI/GitHub rc-release preparation checklist: - [ ] All PRs/issues attached to the release are merged. - [ ] All the badges on the README are passing. - [ ] License information is verified as correct. If you are unsure, please comment below. - [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are - missing), tutorials, and other human written text is up-to-date with any changes in the code. -- [ ] Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated. + missing), tutorials, and other human-written text is up-to-date with any changes in the code. +- [ ] Installation instructions in the README, documentation, and the website (e.g., diffpy.org) are updated. - [ ] Successfully run any tutorial examples or do functional testing with the latest Python version. - [ ] Grammar and writing quality are checked (no typos). +- [ ] 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. -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: +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: -### conda-forge release checklist: +### PyPI/GitHub full-release preparation checklist: + +- [ ] Create a new conda environment and install the rc from PyPI (`pip install ==??`) +- [ ] License information on PyPI is correct. +- [ ] Docs are deployed successfully to `https://www.diffpy.org/`. +- [ ] Successfully run all tests, tutorial examples or do functional testing. + +Please let @sbillinge know that all checks are done and the package is ready for full release. + +### conda-forge release preparation checklist: +- [ ] Ensure that the full release has appeared on PyPI successfully. - [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock. -- [ ] All relevant issues in the feedstock are addressed in the release PR. +- [ ] Close any open issues on the feedstock. Reach out to @bobleesj if you have questions. +- [ ] Tag @sbillinge and @bobleesj for conda-forge release. ### Post-release checklist From 32a55efd147d1e748808a58f9b813f0843f679d1 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 13 Dec 2024 12:49:18 -0500 Subject: [PATCH 2/3] Add news --- news/latest-checklist.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/latest-checklist.md diff --git a/news/latest-checklist.md b/news/latest-checklist.md new file mode 100644 index 0000000..099f2fe --- /dev/null +++ b/news/latest-checklist.md @@ -0,0 +1,23 @@ +**Added:** + +* Latest release checklist containing steps for `twine check dist/*` and `python -m build` + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* From 6be27059a65056823f364ab06e30759e7c0607fd Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Fri, 13 Dec 2024 12:49:42 -0500 Subject: [PATCH 3/3] Rename latest-checklist.md to latest-checklist.rst --- news/{latest-checklist.md => latest-checklist.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename news/{latest-checklist.md => latest-checklist.rst} (100%) diff --git a/news/latest-checklist.md b/news/latest-checklist.rst similarity index 100% rename from news/latest-checklist.md rename to news/latest-checklist.rst