Skip to content

Ready for 3.1.2 PyPI/GitHub release #96

Closed

Description

@cadenmyers13

checklist for diffpy.cmi

  • Manually trigger the validate-examples.yml workflow 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 with cmi install docs && cd docs && make html && open build/html/index.html, running cmi 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, run python -m build and twine 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.txt and test.txt are added to meta.yaml in 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.

Activity

  1. changed the title [-]Ready for 3.2.0 PyPI/GitHub release[/-] [+]Ready for 3.1.2 PyPI/GitHub release[/+] on Dec 19, 2025
  2. cadenmyers13 commented on Dec 19, 2025

    @cadenmyers13
    ContributorAuthor

    @sbillinge pypi rc release is ready after this PR is merged: #97

  3. sbillinge commented on Dec 19, 2025

    @sbillinge
    Contributor

    ok, I pushed out the 3.1.2-rc.0 release

  4. sbillinge commented on Dec 19, 2025

    @sbillinge
    Contributor

    @cadenmyers13 please can you pin sphinx to spinx<9 in the docs.txt so 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.

  5. cadenmyers13 commented on Dec 19, 2025

    @cadenmyers13
    ContributorAuthor

    @sbillinge done, created the PR and this issue: #99

  6. sbillinge commented on Dec 19, 2025

    @sbillinge
    Contributor

    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.

  7. cadenmyers13 commented on Dec 19, 2025

    @cadenmyers13
    ContributorAuthor

    @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.

  8. cadenmyers13 commented on Dec 19, 2025

    @cadenmyers13
    ContributorAuthor

    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 rc1 just in case.

  9. sbillinge commented on Dec 20, 2025

    @sbillinge
    Contributor

    @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.

  10. cadenmyers13 commented on Dec 20, 2025

    @cadenmyers13
    ContributorAuthor

    @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!

  11. cadenmyers13 commented on Dec 21, 2025

    @cadenmyers13
    ContributorAuthor

    closing as released

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions