add CI for Rust Docs#1313
Merged
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1313 +/- ##
=======================================
Coverage 19.08% 19.08%
=======================================
Files 166 166
Lines 11066 11066
=======================================
Hits 2112 2112
Misses 8954 8954
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Contributor
Bencher Report
Contributor
|
| Branch | all-features-docs |
| Testbed | sv2 |
🚨 1 Alert
| Benchmark | Measure Units | View | Benchmark Result (Result Δ%) | Upper Boundary (Limit %) |
|---|---|---|---|---|
| client_sv2_open_channel_serialize_deserialize | L2 Accesses accesses | 📈 plot 🚨 alert (🔔) 🚷 threshold | 92.00 (+22.12%) | 89.10 (103.25%) |
Click to view all benchmark results
| Benchmark | Estimated Cycles | Benchmark Result estimated cycles (Result Δ%) | Upper Boundary 1e3 x estimated cycles (Limit %) | Instructions | Benchmark Result instructions (Result Δ%) | Upper Boundary instructions (Limit %) | L1 Accesses | Benchmark Result accesses (Result Δ%) | Upper Boundary accesses (Limit %) | L2 Accesses | Benchmark Result accesses (Result Δ%) | Upper Boundary accesses (Limit %) | RAM Accesses | Benchmark Result accesses (Result Δ%) | Upper Boundary accesses (Limit %) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_sv2_handle_message_common | 📈 view plot 🚷 view threshold | 2.10 (-0.28%) | 2.23 (94.49%) | 📈 view plot 🚷 view threshold | 473.00 (-0.05%) | 488.92 (96.74%) | 📈 view plot 🚷 view threshold | 733.00 (-0.36%) | 757.93 (96.71%) | 📈 view plot 🚷 view threshold | 8.00 (+60.25%) | 12.01 (66.61%) | 📈 view plot 🚷 view threshold | 38.00 (-1.36%) | 41.53 (91.51%) |
| client_sv2_handle_message_mining | 📈 view plot 🚷 view threshold | 8.29 (+0.82%) | 8.38 (98.86%) | 📈 view plot 🚷 view threshold | 2,137.00 (-0.01%) | 2,140.48 (99.84%) | 📈 view plot 🚷 view threshold | 3,153.00 (-0.20%) | 3,169.23 (99.49%) | 📈 view plot 🚷 view threshold | 40.00 (+12.55%) | 41.79 (95.72%) | 📈 view plot 🚷 view threshold | 141.00 (+1.05%) | 144.04 (97.89%) |
| client_sv2_mining_message_submit_standard | 📈 view plot 🚷 view threshold | 6.29 (-0.07%) | 6.44 (97.70%) | 📈 view plot 🚷 view threshold | 1,750.00 (-0.02%) | 1,766.19 (99.08%) | 📈 view plot 🚷 view threshold | 2,548.00 (-0.15%) | 2,574.59 (98.97%) | 📈 view plot 🚷 view threshold | 21.00 (+22.91%) | 24.31 (86.40%) | 📈 view plot 🚷 view threshold | 104.00 (-0.55%) | 108.57 (95.79%) |
| client_sv2_mining_message_submit_standard_serialize | 📈 view plot 🚷 view threshold | 14.69 (-0.21%) | 14.93 (98.40%) | 📈 view plot 🚷 view threshold | 4,694.00 (-0.01%) | 4,710.19 (99.66%) | 📈 view plot 🚷 view threshold | 6,747.00 (-0.14%) | 6,785.73 (99.43%) | 📈 view plot 🚷 view threshold | 56.00 (+24.68%) | 61.03 (91.75%) | 📈 view plot 🚷 view threshold | 219.00 (-0.99%) | 226.37 (96.74%) |
| client_sv2_mining_message_submit_standard_serialize_deserialize | 📈 view plot 🚷 view threshold | 27.71 (+0.46%) | 28.00 (98.96%) | 📈 view plot 🚷 view threshold | 10,645.00 (+0.40%) | 10,686.96 (99.61%) | 📈 view plot 🚷 view threshold | 15,500.00 (+0.44%) | 15,574.62 (99.52%) | 📈 view plot 🚷 view threshold | 97.00 (+16.64%) | 98.17 (98.81%) | 📈 view plot 🚷 view threshold | 335.00 (-0.08%) | 342.38 (97.84%) |
| client_sv2_open_channel | 📈 view plot 🚷 view threshold | 4.42 (+0.65%) | 4.55 (97.10%) | 📈 view plot 🚷 view threshold | 1,461.00 (-0.02%) | 1,476.92 (98.92%) | 📈 view plot 🚷 view threshold | 2,156.00 (-0.21%) | 2,183.65 (98.73%) | 📈 view plot 🚷 view threshold | 12.00 (+48.12%) | 13.64 (88.00%) | 📈 view plot 🚷 view threshold | 63.00 (+0.61%) | 67.08 (93.91%) |
| client_sv2_open_channel_serialize | 📈 view plot 🚷 view threshold | 13.98 (-0.26%) | 14.19 (98.51%) | 📈 view plot 🚷 view threshold | 5,064.00 (-0.00%) | 5,079.92 (99.69%) | 📈 view plot 🚷 view threshold | 7,320.00 (-0.08%) | 7,351.38 (99.57%) | 📈 view plot 🚷 view threshold | 44.00 (+22.20%) | 47.20 (93.21%) | 📈 view plot 🚷 view threshold | 184.00 (-1.08%) | 190.99 (96.34%) |
| client_sv2_open_channel_serialize_deserialize | 📈 view plot 🚷 view threshold | 22.85 (+0.72%) | 23.00 (99.34%) | 📈 view plot 🚷 view threshold | 8,040.00 (+0.11%) | 8,053.90 (99.83%) | 📈 view plot 🚷 view threshold | 11,682.00 (-0.01%) | 11,711.07 (99.75%) | 📈 view plot 🚨 view alert (🔔) 🚷 view threshold | 92.00 (+22.12%) | 89.10 (103.25%) | 📈 view plot 🚷 view threshold | 306.00 (+0.77%) | 311.13 (98.35%) |
| client_sv2_setup_connection | 📈 view plot 🚷 view threshold | 4.68 (-0.05%) | 4.78 (97.91%) | 📈 view plot 🚷 view threshold | 1,502.00 (-0.02%) | 1,517.92 (98.95%) | 📈 view plot 🚷 view threshold | 2,275.00 (-0.14%) | 2,299.53 (98.93%) | 📈 view plot 🚷 view threshold | 13.00 (+37.41%) | 15.61 (83.29%) | 📈 view plot 🚷 view threshold | 67.00 (-0.72%) | 70.01 (95.70%) |
| client_sv2_setup_connection_serialize | 📈 view plot 🚷 view threshold | 16.19 (+0.24%) | 16.31 (99.27%) | 📈 view plot 🚷 view threshold | 5,963.00 (-0.00%) | 5,978.92 (99.73%) | 📈 view plot 🚷 view threshold | 8,653.00 (-0.13%) | 8,691.63 (99.56%) | 📈 view plot 🚷 view threshold | 51.00 (+27.43%) | 54.35 (93.84%) | 📈 view plot 🚷 view threshold | 208.00 (-0.07%) | 211.89 (98.16%) |
| client_sv2_setup_connection_serialize_deserialize | 📈 view plot 🚷 view threshold | 35.70 (+0.33%) | 35.90 (99.46%) | 📈 view plot 🚷 view threshold | 14,888.00 (+0.16%) | 14,912.40 (99.84%) | 📈 view plot 🚷 view threshold | 21,864.00 (+0.11%) | 21,910.72 (99.79%) | 📈 view plot 🚷 view threshold | 115.00 (+23.32%) | 116.92 (98.35%) | 📈 view plot 🚷 view threshold | 379.00 (-0.11%) | 385.05 (98.43%) |
Contributor
|
| Branch | all-features-docs |
| Testbed | sv2 |
Click to view all benchmark results
| Benchmark | Latency | Benchmark Result nanoseconds (ns) (Result Δ%) | Upper Boundary nanoseconds (ns) (Limit %) |
|---|---|---|---|
| client_sv2_handle_message_common | 📈 view plot 🚷 view threshold | 44.38 (-1.74%) | 58.56 (75.79%) |
| client_sv2_handle_message_mining | 📈 view plot 🚷 view threshold | 86.11 (+9.93%) | 105.27 (81.80%) |
| client_sv2_mining_message_submit_standard | 📈 view plot 🚷 view threshold | 14.70 (+0.23%) | 14.72 (99.84%) |
| client_sv2_mining_message_submit_standard_serialize | 📈 view plot 🚷 view threshold | 264.79 (-0.62%) | 288.72 (91.71%) |
| client_sv2_mining_message_submit_standard_serialize_deserialize | 📈 view plot 🚷 view threshold | 611.24 (-0.23%) | 645.70 (94.66%) |
| client_sv2_open_channel | 📈 view plot 🚷 view threshold | 161.89 (-1.76%) | 175.99 (91.99%) |
| client_sv2_open_channel_serialize | 📈 view plot 🚷 view threshold | 285.46 (+0.03%) | 308.83 (92.43%) |
| client_sv2_open_channel_serialize_deserialize | 📈 view plot 🚷 view threshold | 380.47 (-0.81%) | 408.20 (93.21%) |
| client_sv2_setup_connection | 📈 view plot 🚷 view threshold | 160.10 (+0.14%) | 170.62 (93.84%) |
| client_sv2_setup_connection_serialize | 📈 view plot 🚷 view threshold | 492.39 (+4.30%) | 553.63 (88.94%) |
| client_sv2_setup_connection_serialize_deserialize | 📈 view plot 🚷 view threshold | 1,014.80 (+1.43%) | 1,143.40 (88.75%) |
Contributor
|
| Branch | all-features-docs |
| Testbed | sv1 |
Click to view all benchmark results
| Benchmark | Estimated Cycles | Benchmark Result estimated cycles (Result Δ%) | Upper Boundary 1e3 x estimated cycles (Limit %) | Instructions | Benchmark Result instructions (Result Δ%) | Upper Boundary 1e3 x instructions (Limit %) | L1 Accesses | Benchmark Result accesses (Result Δ%) | Upper Boundary 1e3 x accesses (Limit %) | L2 Accesses | Benchmark Result accesses (Result Δ%) | Upper Boundary accesses (Limit %) | RAM Accesses | Benchmark Result accesses (Result Δ%) | Upper Boundary accesses (Limit %) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| get_authorize | 📈 view plot 🚷 view threshold | 8.45 (-0.07%) | 8.67 (97.39%) | 📈 view plot 🚷 view threshold | 3.66 (-1.84%) | 3.86 (94.85%) | 📈 view plot 🚷 view threshold | 5.11 (-2.25%) | 5.45 (93.79%) | 📈 view plot 🚷 view threshold | 10.00 (+23.31%) | 15.60 (64.12%) | 📈 view plot 🚷 view threshold | 94.00 (+3.19%) | 96.07 (97.84%) |
| get_submit | 📈 view plot 🚷 view threshold | 95.37 (+0.00%) | 95.68 (99.68%) | 📈 view plot 🚷 view threshold | 59.26 (-0.26%) | 59.71 (99.26%) | 📈 view plot 🚷 view threshold | 85.07 (-0.31%) | 85.82 (99.13%) | 📈 view plot 🚷 view threshold | 51.00 (+14.93%) | 59.91 (85.12%) | 📈 view plot 🚷 view threshold | 287.00 (+2.36%) | 290.37 (98.84%) |
| get_subscribe | 📈 view plot 🚷 view threshold | 7.96 (-0.56%) | 8.23 (96.62%) | 📈 view plot 🚷 view threshold | 2.76 (-2.16%) | 2.94 (93.70%) | 📈 view plot 🚷 view threshold | 3.83 (-2.59%) | 4.14 (92.48%) | 📈 view plot 🚷 view threshold | 13.00 (+6.67%) | 20.22 (64.29%) | 📈 view plot 🚷 view threshold | 116.00 (+1.32%) | 117.82 (98.46%) |
| serialize_authorize | 📈 view plot 🚷 view threshold | 12.23 (-0.26%) | 12.51 (97.76%) | 📈 view plot 🚷 view threshold | 5.24 (-1.21%) | 5.43 (96.56%) | 📈 view plot 🚷 view threshold | 7.28 (-1.50%) | 7.60 (95.76%) | 📈 view plot 🚷 view threshold | 10.00 (+1.19%) | 18.40 (54.34%) | 📈 view plot 🚷 view threshold | 140.00 (+1.62%) | 142.31 (98.38%) |
| serialize_deserialize_authorize | 📈 view plot 🚷 view threshold | 24.66 (-0.21%) | 25.18 (97.92%) | 📈 view plot 🚷 view threshold | 9.79 (-0.80%) | 10.02 (97.70%) | 📈 view plot 🚷 view threshold | 13.79 (-0.96%) | 14.18 (97.24%) | 📈 view plot 🚷 view threshold | 32.00 (-10.08%) | 45.59 (70.19%) | 📈 view plot 🚷 view threshold | 306.00 (+0.94%) | 313.13 (97.72%) |
| serialize_deserialize_handle_authorize | 📈 view plot 🚷 view threshold | 30.28 (-0.15%) | 30.72 (98.55%) | 📈 view plot 🚷 view threshold | 11.99 (-0.57%) | 12.19 (98.34%) | 📈 view plot 🚷 view threshold | 16.95 (-0.69%) | 17.30 (98.01%) | 📈 view plot 🚷 view threshold | 54.00 (-2.85%) | 66.95 (80.65%) | 📈 view plot 🚷 view threshold | 373.00 (+0.61%) | 379.28 (98.34%) |
| serialize_deserialize_handle_submit | 📈 view plot 🚷 view threshold | 126.46 (+0.00%) | 126.78 (99.74%) | 📈 view plot 🚷 view threshold | 73.12 (-0.19%) | 73.53 (99.44%) | 📈 view plot 🚷 view threshold | 104.75 (-0.25%) | 105.49 (99.30%) | 📈 view plot 🚷 view threshold | 120.00 (+13.06%) | 125.47 (95.64%) | 📈 view plot 🚷 view threshold | 603.00 (+0.95%) | 608.10 (99.16%) |
| serialize_deserialize_handle_subscribe | 📈 view plot 🚷 view threshold | 27.91 (-0.00%) | 28.42 (98.20%) | 📈 view plot 🚷 view threshold | 9.58 (-0.62%) | 9.76 (98.14%) | 📈 view plot 🚷 view threshold | 13.52 (-0.80%) | 13.83 (97.69%) | 📈 view plot 🚷 view threshold | 71.00 (+10.56%) | 77.46 (91.66%) | 📈 view plot 🚷 view threshold | 401.00 (+0.53%) | 410.67 (97.65%) |
| serialize_deserialize_submit | 📈 view plot 🚷 view threshold | 115.19 (-0.05%) | 115.71 (99.54%) | 📈 view plot 🚷 view threshold | 67.89 (-0.26%) | 68.41 (99.24%) | 📈 view plot 🚷 view threshold | 97.36 (-0.33%) | 98.28 (99.06%) | 📈 view plot 🚷 view threshold | 73.00 (+13.30%) | 85.72 (85.16%) | 📈 view plot 🚷 view threshold | 499.00 (+1.27%) | 501.78 (99.45%) |
| serialize_deserialize_subscribe | 📈 view plot 🚷 view threshold | 23.27 (-0.23%) | 23.83 (97.62%) | 📈 view plot 🚷 view threshold | 8.13 (-0.76%) | 8.31 (97.77%) | 📈 view plot 🚷 view threshold | 11.43 (-0.92%) | 11.74 (97.30%) | 📈 view plot 🚷 view threshold | 37.00 (-3.88%) | 50.23 (73.67%) | 📈 view plot 🚷 view threshold | 333.00 (+0.51%) | 342.84 (97.13%) |
| serialize_submit | 📈 view plot 🚷 view threshold | 99.83 (+0.03%) | 100.13 (99.69%) | 📈 view plot 🚷 view threshold | 61.33 (-0.23%) | 61.73 (99.34%) | 📈 view plot 🚷 view threshold | 87.93 (-0.29%) | 88.64 (99.19%) | 📈 view plot 🚷 view threshold | 56.00 (+17.89%) | 66.00 (84.85%) | 📈 view plot 🚷 view threshold | 332.00 (+2.13%) | 335.66 (98.91%) |
| serialize_subscribe | 📈 view plot 🚷 view threshold | 11.44 (+0.31%) | 11.60 (98.58%) | 📈 view plot 🚷 view threshold | 4.11 (-1.36%) | 4.28 (95.97%) | 📈 view plot 🚷 view threshold | 5.69 (-1.74%) | 6.00 (94.90%) | 📈 view plot 🚷 view threshold | 15.00 (+11.37%) | 23.08 (64.99%) | 📈 view plot 🚷 view threshold | 162.00 (+2.32%) | 163.58 (99.04%) |
Contributor
|
My personal roadmap for
(going bottom-up in the dep graph) |
Contributor
|
Actually, |
Contributor
|
done : #1315 |
plebhash
force-pushed
the
all-features-docs
branch
from
a91b36e to
015169c
Compare
plebhash
force-pushed
the
all-features-docs
branch
from
015169c to
6c5cc0d
Compare
plebhash
force-pushed
the
all-features-docs
branch
2 times, most recently
from
ec7e8e5 to
494c8fb
Compare
plebhash
force-pushed
the
all-features-docs
branch
from
494c8fb to
6269cb1
Compare
GitGab19
approved these changes
Jan 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
close #1311
adds a new CI that enforces Rust Docs are not broken