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

[MNT] updates for release #297

Merged
merged 15 commits into from
Aug 1, 2024
Merged

[MNT] updates for release #297

merged 15 commits into from
Aug 1, 2024

Conversation

SUKI-O
Copy link
Member

@SUKI-O SUKI-O commented Jul 14, 2024

Reference Issues/PRs

#292

What does this implement/fix? Explain your changes.

Update pyproject.toml for releasing treeple
Update Licence

Any other comments?

Copy link

codecov bot commented Jul 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.53%. Comparing base (dd28c41) to head (7c5db30).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #297   +/-   ##
=======================================
  Coverage   78.53%   78.53%           
=======================================
  Files          24       24           
  Lines        2250     2250           
  Branches      413      413           
=======================================
  Hits         1767     1767           
  Misses        352      352           
  Partials      131      131           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SUKI-O SUKI-O requested a review from adam2392 July 15, 2024 13:13
Copy link
Collaborator

@adam2392 adam2392 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. What is the process you will take to make a release now? Is it clear from the developer documentation?

If not, perhaps we can simultaneously make that crystal clear, so anyone (you and me and anyone else) can do the release process easily in the future.

CITATION.cff Show resolved Hide resolved
@adam2392
Copy link
Collaborator

adam2392 commented Jul 16, 2024

FYI you released a version onto pypi that is not installable from non-macm1-non-python3.9 environments: https://pypi.org/project/treeple/#files.

Can you re-release v0.9.1?

If you take a look at the previous versions, there are many wheels. Lmk if there are developer documentation instructions that are unclear, or need patching. You can use testpypi to test it out. Feel free to write out a step-by-step process here if you want me to double check.

@adam2392
Copy link
Collaborator

adam2392 commented Jul 19, 2024

In addition, you will want to:

  1. Update https://github.com/neurodata/treeple/blob/main/doc/whats_new.rst
  2. Update https://github.com/neurodata/treeple/blob/main/doc/whats_new/v0.9.rst release changelog file. You can just do things like remove "In development" and add any quick summary notes that are important that we changed.
  3. Add a new whats_new file for the next version.
  4. Rebuild the documentation locally
    1. make a tag on GH for v0.9.x and freeze what you have rn according to that tag
  5. make a release and upload the wheels https://github.com/neurodata/treeple/releases (this should theoretically trigger the release workflow to release on PyPi, but you already released, so I think it'll just won't do it). This provides a place for ppl to download that isn't via pypi.
  6. In gh-pages, upload the documentation under the new version folder name (e.g. v0.9)
  7. update the _versions.json in https://github.com/neurodata/treeple/blob/main/doc/_static/versions.json
  8. Finally, is https://github.com/neurodata/treeple/blob/main/DEVELOPING.md#making-a-release reflective of what you have done?

dev/ docs will take care of themselves and get uploaded via circleCI. Lmk if that makes sense and is reflected in #299 ?

@adam2392
Copy link
Collaborator

@SUKI-O can you address these final points for releasing v0.9.x, so that development of v0.10 can begin?

@SUKI-O
Copy link
Member Author

SUKI-O commented Aug 1, 2024

@adam2392 can you review the changes, redux of release etc.. Sorry it took so long. LMK if I need to fix smtg else.

Copy link
Collaborator

@adam2392 adam2392 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

I think this file seems like it's extra so can be removed doc/sg_execution_times.rst

Were you able to update the gh-pages with relevant documentation?

https://docs.neurodata.io/treeple/v0.9/install.html for some reason still shows the dev0 header. One thing you can do if the docs already built in there is just ctrl+f the extra portion and delete it. 0.9.dev0 -> 0.9 and update the docs in gh-pages manually. Let me know if that makes sense.

Other than these two minor issues, it LGTM! Now you know how to deal with 99% of the OSS developer stuff out there :)

Signed-off-by: Adam Li <adam2392@gmail.com>
@adam2392
Copy link
Collaborator

adam2392 commented Aug 1, 2024

Looking good!

I think this file seems like it's extra so can be removed doc/sg_execution_times.rst

Were you able to update the gh-pages with relevant documentation?

https://docs.neurodata.io/treeple/v0.9/install.html for some reason still shows the dev0 header. One thing you can do if the docs already built in there is just ctrl+f the extra portion and delete it. 0.9.dev0 -> 0.9 and update the docs in gh-pages manually. Let me know if that makes sense.

Other than these two minor issues, it LGTM! Now you know how to deal with 99% of the OSS developer stuff out there :)

I have fixed both these issues by pushing to gh-pages and this PR branch, since it's minor.

I will merge this in now, and then create a new branch on GH called v0.9.x indicating a state for our stuff to live on in v0.9.x. Just as a FYI, this helps in backtracking any crazy bugs we need a quick fix for. We would just push/PR directly to the branch v0.9.x, and do a new release v0.9.2.

Signed-off-by: Adam Li <adam2392@gmail.com>
@adam2392 adam2392 merged commit 74a5ac5 into main Aug 1, 2024
37 checks passed
@adam2392 adam2392 deleted the rename branch August 1, 2024 20:05
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

Successfully merging this pull request may close these issues.

2 participants