Repository navigation
Ready for 3.1.2 PyPI/GitHub release #96
Copy link
Copy link
Closed
Description
checklist for diffpy.cmi
- Manually trigger the
validate-examples.ymlworkflow to run all example scripts. - Make sure available examples, packs, and profiles are listed in the docs. Check this by installing locally with
pip install ., building the docs withcmi install docs && cd docs && make html && open build/html/index.html, runningcmi info, and comparing the output to what is listed under "Examples" in the docs.
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 the website 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, runpython -m buildandtwine check dist/*to ensure that the package can be built and is correctly formatted for PyPI release.
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:
PyPI/GitHub full-release preparation checklist:
- Create a new conda environment and install the rc from PyPI (
pip install <package-name>==??) - License information on PyPI is correct.
- Docs are deployed successfully to
https://<github-username-or-orgname>/<package-name>. - Successfully run all tests, tutorial examples or do functional testing.
Please let the maintainer 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.txtandtest.txtare added tometa.yamlin the feedstock. - Close any open issues on the feedstock. Reach out to the maintainer if you have questions.
- Tag the maintainer for conda-forge release.
Post-release checklist
- Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
- Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Activity
[-]Ready for 3.2.0 PyPI/GitHub release[/-][+]Ready for 3.1.2 PyPI/GitHub release[/+]cadenmyers13 commentedon Dec 19, 2025
@sbillinge pypi rc release is ready after this PR is merged: #97
sbillinge commentedon Dec 19, 2025
ok, I pushed out the
3.1.2-rc.0releasesbillinge commentedon Dec 19, 2025
@cadenmyers13 please can you pin sphinx to
spinx<9in thedocs.txtso that the docs build and deploy on hte full release? Also, create an issue ot remove the pin when sphinx_rtd_theme supports sphinx 9. Thanks.cadenmyers13 commentedon Dec 19, 2025
@sbillinge done, created the PR and this issue: #99
sbillinge commentedon Dec 19, 2025
let me know when you have tested the rc release and I will push out a full release. We could also wait a bit to see if we catch any more things.
cadenmyers13 commentedon Dec 19, 2025
@sbillinge The Readme hasnt been updated so I fixed that in a PR. Also, Im not seeing the docs deployed for
3.1.2rc0. I assume this has to do with the sphinx version issue.cadenmyers13 commentedon Dec 19, 2025
Otherwise everything is working good. The examples are shipped and i was able to copy and run them. Also was able to install packs and profiles as intended. Might want to do an
rc1just in case.sbillinge commentedon Dec 20, 2025
@cadenmyers13 thanks for testing! The release worked and the docs deployed. Please could you work on the conda-forge release and we can get this out the door.
cadenmyers13 commentedon Dec 20, 2025
@sbillinge Its showing up on conda-forge but I cant install 3.1.2 yet. Will give it a sec then we should be able to close this!
cadenmyers13 commentedon Dec 21, 2025
closing as released