Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ready for 1.5.0rc PyPI/GitHub release #123

Closed
1 of 17 tasks
sbillinge opened this issue Jan 12, 2025 · 1 comment
Closed
1 of 17 tasks

Ready for 1.5.0rc PyPI/GitHub release #123

sbillinge opened this issue Jan 12, 2025 · 1 comment

Comments

@sbillinge
Copy link
Contributor

sbillinge commented Jan 12, 2025

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.
  • Successfully run any tutorial examples or do functional testing with the latest Python version.
  • Grammar and writing quality are checked (no typos).

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:

PyPI/GitHub full-release preparation checklist:

  • Create a new conda environment and install the rc from pypi (pip install <package-name>=??)
  • License information at Pypi is verified as correct.
  • Docs deployed successfully to <package-name>.github.io
  • Successfully run all tests, tutorial examples or do functional testing

Please let @sbillinge know that all checks are done and 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 @bobleesj if you have questions
  • let @sbillinge and @bobleesj when this is ready

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.
@sbillinge sbillinge added this to the v 1.5.0rc0 pre-release milestone Jan 12, 2025
@sbillinge
Copy link
Contributor Author

closed by #125

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant