-
Notifications
You must be signed in to change notification settings - Fork 18
Packaging: Use of pyproject.toml
and move to minimal setup.py
for modernization
#123
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
base: develop
Are you sure you want to change the base?
Conversation
… and minimal setup.py
pyproject.toml
Outdated
dependencies = [ | ||
"ndsl @ git+https://github.com/NOAA-GFDL/NDSL.git@develop", | ||
"pyFV3 @ git+https://github.com/NOAA-GFDL/PyFV3.git@develop", | ||
"pySHiELD @ git+https://github.com/NOAA-GFDL/PySHiELD.git@develop", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So the issue with that is we can't control for release anymore. When you pull the package you get develop
, which is risky but ok if you are on the develop
branch of Pace (you agree to be on the "expected stable" branch, with the caveat).
But when you release Pace you want hard encoded versions. Is the plan to change those path to a release tag when making a release with Pace?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitely need a broader discussion on this, but I think moving forward we will have release
branches that will point to the most recent release for each dependency, while the develop
branch will point to the develop branches. I will be pushing a minor change shortly that will amend the current CI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a bad strategy, it would made the "release" commit pretty clear and allow "released" codebase to also be moved onto develop
or other branch after the fact, which is a nice perk.
There's probably something out there that automatize this process, though it's simple enough it can be documented up (so you and I aren't the only ones knowing how to release!).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice nice
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Description
This PR moves the metadata and configuration for the package to a
pyproject.toml
file, as is prescribed by Deprecate legacy setup.py develop mechanism for pip install --editable #11457. The previoussetup.py
file is now minimal.Fixes # (118)
This PR also addresses Issue 118
How Has This Been Tested?
Tested using the current CI suite.
Checklist: