Skip to content

Ready for 0.3.0 PyPI/GitHub release #91

Open

Description

@sbillinge

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. added this to the 0.3.0 release milestone on Apr 3, 2026
  2. stevenhua0320 commented on Apr 4, 2026

    @stevenhua0320
    Contributor
    1. All PRs are now merged
    2. I have checked the current README.rst, the badges are all passing and exist.
    3. Have added the latest license holder, so it should be proper now.
    4. Locally rendered documentation is shown here:
    Image Image 5. We haven't modified anything here, so it should be fine. 6. Local `pytest` is run with `python 3.14`, and it is all passing
    (diffpy.fourigui-env) huarundong@Stevens-MacBook-Pro-405 diffpy.fourigui % pytest
    ================================================================================================================== test session starts ===================================================================================================================
    platform darwin -- Python 3.14.3, pytest-9.0.2, pluggy-1.6.0
    rootdir: /Users/huarundong/dbs/diffpy.fourigui
    configfile: pyproject.toml
    plugins: mock-3.15.1, cov-7.1.0, env-1.6.0
    collected 17 items                                                                                                                                                                                                                                       
    
    tests/integration_test.py ......                                                                                                                                                                                                                   [ 35%]
    tests/test_fourigui.py ..........                                                                                                                                                                                                                  [ 94%]
    tests/test_version.py .                                                                                                                                                                                                                            [100%]
    
    =================================================================================================================== 17 passed in 1.15s ===================================================================================================================
    
    1. Checked with the current documentation and it is all good.
    2. The test for build is passing.
    (diffpy.fourigui-env) huarundong@Stevens-MacBook-Pro-405 diffpy.fourigui % twine check dist/*                                              
    Checking dist/diffpy_fourigui-0.0.1-py3-none-any.whl: PASSED
    Checking dist/diffpy_fourigui-0.0.1.tar.gz: PASSED
    
  3. sbillinge commented on Apr 4, 2026

    @sbillinge
    ContributorAuthor

    I know I mentioned that we wouldn't re-package this but let's just quickly do it and close all the issues on the 0.3.0 milestone. I think it will be quite quick and it just keeps things up to date for hte future.

  4. stevenhua0320 commented on Apr 7, 2026

    @stevenhua0320
    Contributor

    @sbillinge

    1. Have installed the PyPI pre-release version.
    2. License is correct on PyPI
    Image
    1. I have made another PR fix: fix documentation on fourigui #95 to fix the documentation, maybe we could make another pre-release to verify if we have fixed the documentation there.
    2. pytest is running successfully on all tests.
    (diffpy.fourigui-env) huarundong@Stevens-MacBook-Pro-405 diffpy.fourigui % pytest
    ================================================================================================================== test session starts ===================================================================================================================
    platform darwin -- Python 3.14.3, pytest-9.0.2, pluggy-1.6.0
    rootdir: /Users/huarundong/dbs/diffpy.fourigui/diffpy.fourigui
    configfile: pyproject.toml
    plugins: mock-3.15.1, cov-7.1.0, env-1.6.0
    collected 17 items                                                                                                                                                                                                                                       
    
    tests/integration_test.py ......                                                                                                                                                                                                                   [ 35%]
    tests/test_fourigui.py ..........                                                                                                                                                                                                                  [ 94%]
    tests/test_version.py .                                                                                                                                                                                                                            [100%]
    
    =================================================================================================================== 17 passed in 1.25s ================================================================================================================
    
  5. sbillinge commented on Apr 7, 2026

    @sbillinge
    ContributorAuthor

    OK, I pushed out rc.1 IF the docs build ok let me know and I will do the full release. You don't need to check everything else over again.

  6. sbillinge commented on Apr 7, 2026

    @sbillinge
    ContributorAuthor

    This time I just ran the doc build on dispatch. Let's see if that checks it. Then I can push out an rc and then a full

  7. stevenhua0320 commented on Apr 7, 2026

    @stevenhua0320
    Contributor

    This time I just ran the doc build on dispatch. Let's see if that checks it. Then I can push out an rc and then a full

    It seems that the single workflow fails for some reason, maybe we need to redo that?

  8. sbillinge commented on Apr 7, 2026

    @sbillinge
    ContributorAuthor

    OK. I pushed out a new RC release. Please could you make an issue on scikit-package to do some testing on that dispatch workflow and see if we can fix it? It would be nice to be able to deploy docs from dispatch.

  9. stevenhua0320 commented on Apr 7, 2026

    @stevenhua0320
    Contributor

    I have made that issue on scikit-package. For the documentation on pre-release, seems it is not reflecting the change made by the last PR #96 since it still displays the undefined module. But I confirmed from my local that indeed we have replaced it to a static one and it displays properly... Is that owning to we might need a full release so that these change on documentation could be reflected?
    This is the current pre-release documentation page:

    Image This is my local build page: Image
  10. sbillinge commented on Apr 8, 2026

    @sbillinge
    ContributorAuthor

    no, that was my error. I forgot to pull upstream before making the new tag. I pushed out an rc3 now. Sorry about that. Getting tired here.

  11. stevenhua0320 commented on Apr 8, 2026

    @stevenhua0320
    Contributor
    Image OK, now I confirmed that we are good here! we can make a full release then.
  12. sbillinge commented on Apr 8, 2026

    @sbillinge
    ContributorAuthor

    OK, thanks @stevenhua0320 . 0.3.0 got sent.

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

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions