-
Notifications
You must be signed in to change notification settings - Fork 659
hide turbine crate from external use #7392
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: master
Are you sure you want to change the base?
Conversation
87659bb
to
214268c
Compare
This will not clear CI, need to think about how to get this to build. |
d33cb41
to
c4b5b69
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #7392 +/- ##
=========================================
- Coverage 83.3% 83.3% -0.1%
=========================================
Files 800 800
Lines 362783 362682 -101
=========================================
- Hits 302227 302126 -101
Misses 60556 60556 🚀 New features to boost your workflow:
|
CC @jacobcreech - I'm assuming these crates aren't actually used much by anyone |
https://crates.io/crates/solana-turbine/reverse_dependencies shows no users outside agave. Does not appear like anyone is interested in it. If someone is interested they can file a PR. |
Looks like it has some usage in random SVM L2s too https://github.com/search?q=solana-turbine+language%3ATOML&type=code&l=TOML&p=1 |
We have an OK from Jito's @esemeniuc to do the change. |
Well we are not yanking the crate, we are just making no promises to keep the API stable. An alternative would be to build a new turbine crate from scratch and let the current one bitrot. |
c4b5b69
to
6fd20e0
Compare
FYI - this PR has a v3.0 label that I'm removing; we use labels of this format for backports once the |
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.
This looks good to me. Will make development much simpler. Although, I don't have much knowledge on general coding practice here. Is there an eventual plan to remove this gating at some point?
The whole idea with hidden API has been bobbing around for a while, but there is no established procedure. We should consider removing it once API stabilizes, or if lots of downstream users ask for it. |
6fd20e0
to
caf1682
Compare
Problem
We have a bunch of changes planned for turbine which would require breaking lots (most?) of its public API
Summary of Changes
Hide turbine crate behind agave-unstable-api to avoid the maintenance burden associated with public API