-
Notifications
You must be signed in to change notification settings - Fork 136
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
simplify [package.metadata.docs.rs]
on protocols
crates
#1318
base: main
Are you sure you want to change the base?
Conversation
publishing with all-features is overengineering: - no_std is being deprecated via stratum-mining#1315 - with_serde will be deprecated soon - no point in publishing docs for code under prop_test
publishing with all-features is overengineering: - no_std is being deprecated via stratum-mining#1315 - with_serde will be deprecated soon
publishing with all-features is overengineering: - no_std is being deprecated via stratum-mining#1315 - with_serde will be deprecated soon
publishing with all-features is overengineering: - no_std is being deprecated via stratum-mining#1315 - with_serde will be deprecated soon - no point in publishing docs for code under prop_test
publishing with all-features is overengineering: - no_std is being deprecated via stratum-mining#1315 - with_serde will be deprecated soon - no point in publishing docs for code under prop_test or disable_nopanic
publishing with all-features is overengineering: - with_serde will be deprecated soon - no point in publishing docs for code under prop_test
this crate doesn't have any features
publishing with all-features is overengineering: - with_serde will be deprecated soon - it is sufficient to publish the docs with with_buffer_pool feature flag
this crate doesn't have any features
publishing with all-features is overengineering: - no_std is being deprecated via stratum-mining#1315 - with_serde will be deprecated soon - it is sufficient to publish the docs with noise_sv2 and with_buffer_pool feature flags
this crate doesn't have any features
publishing with all-features is overengineering: - with_serde will be deprecated soon - no point in publishing docs for code under prop_test feature - it is sufficient to publish the docs with core and with_buffer_pool feature flags
publishing with all-features is overengineering: - no_std is being deprecated - with_serde will be deprecated soon - it is sufficient to publish the docs with with_buffer_pool feature flag
this crate doesn't have any features
publishing with all-features is overengineering: - with_serde will be deprecated soon - no point in publishing docs for debug or fuzz features
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1318 +/- ##
=======================================
Coverage 19.29% 19.29%
=======================================
Files 164 164
Lines 10852 10852
=======================================
Hits 2094 2094
Misses 8758 8758
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Bencher Report
Click to view all benchmark results
|
Bencher Report
🚨 1 Alert
Click to view all benchmark results
|
Bencher Report
🚨 1 Alert
Click to view all benchmark results
|
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.
Please make this a single commit. This makes ALOT of noise in the main
branch.
currently we are making sure all published
protocols
crates cover all of the crates features on Rust Docswe enforce that by having the following on
Cargo.toml
of each crate:this strategy was suggested on #1210 and implemented via #1211
during some discussions in #1311 @jbesraa pointed out that this strategy is a bit overengineered
I agree
all-features
is more generalistic than necessary, and it is causing trouble (e.g.: trying to buildcargo b --all-features
ontemplate_distribution_sv2
breaks due towith_serde
andprop_test
being built together)also, features like
no_std
andwith_serde
are being deprecated, so there's no point in wasting engineering effort on themthis PR is simplifying the
[package.metadata.docs.rs]
parametersnow, for each crate, we only enable publishing Rust Docs with features that are relevant for API usage, namely:
binary_sv2
:features = ["core", "with_buffer_pool"]
binary_codec_sv2
:features = ["with_buffer_pool"]
codec_sv2
:features = ["with_buffer_pool", "noise_sv2"]
framing_sv2
:features = ["with_buffer_pool"]
the following crates have no features that are relevant for API usage, and therefore we don't enforce anything on their
Cargo.toml
:derive_codec_sv2
serde_sv2
const_sv2
noise_sv2
roles_logic_sv2
common_messages_sv2
job_declaration_sv2
mining_sv2
template_distribution_sv2
sv2_ffi
buffer_sv2