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 3.6.0 PyPI/GitHub release #170

Open
18 tasks
alisnwu opened this issue Nov 12, 2024 · 5 comments
Open
18 tasks

Ready for 3.6.0 PyPI/GitHub release #170

alisnwu opened this issue Nov 12, 2024 · 5 comments
Assignees
Milestone

Comments

@alisnwu
Copy link

alisnwu commented Nov 12, 2024

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 (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:

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://www.diffpy.org/<package-name>.
  • 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.
  • 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

  • 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 3.5.1 release milestone Nov 15, 2024
@bobleesj
Copy link
Contributor

@alisnwu Since we are planning for 3 6.0, for now, we could close this issue and re-open or create a new one later when we are ready?

@alisnwu alisnwu closed this as completed Nov 15, 2024
@sbillinge sbillinge changed the title Ready for 3.5.1 PyPI/GitHub release Ready for 3.6.0 PyPI/GitHub release Nov 15, 2024
@sbillinge
Copy link
Contributor

I just edited the title.

@sbillinge sbillinge reopened this Nov 15, 2024
@bobleesj
Copy link
Contributor

bobleesj commented Dec 7, 2024

@alisnwu Could you update checklist here using the link provided here? #202

@bobleesj
Copy link
Contributor

bobleesj commented Dec 7, 2024

Thanks. we can remove the following in the comment since it is metadata.

name: Release
about: Checklist and communication channel for PyPI and GitHub release
title: "Ready for PyPI/GitHub release"
labels: "release"
assignees: ""

@bobleesj
Copy link
Contributor

@alisnwu Just wanted to plan ahead and check in - will you have time for this release in early Jan?

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

3 participants