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.

Sign up for GitHub

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

Jump to bottom

[WIP] add CI for Rust Docs #1313

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[WIP] add CI for Rust Docs #1313

wants to merge 1 commit into from
+126 −0

Conversation

plebhash
Copy link
Collaborator

@plebhash plebhash commented Dec 20, 2024 •
edited
Loading

close #1311

this is still WIP

todos

changes

  • adds a new CI that executes cargo doc --all-features on all protocols crates

@plebhash plebhash added this to the 1.3.0 milestone Dec 20, 2024
@codecov Codecov
Copy link

codecov bot commented Dec 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.29%. Comparing base (e8d76d6) to head (a91b36e).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1313   +/-   ##
=======================================
  Coverage   19.29%   19.29%           
=======================================
  Files         164      164           
  Lines       10852    10852           
=======================================
  Hits         2094     2094           
  Misses       8758     8758
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <ø> (ø)
binary_serde_sv2-coverage 3.65% <ø> (ø)
binary_sv2-coverage 5.48% <ø> (ø)
bip32_derivation-coverage 0.00% <ø> (ø)
buffer_sv2-coverage 25.02% <ø> (ø)
codec_sv2-coverage 0.01% <ø> (ø)
common_messages_sv2-coverage 0.13% <ø> (ø)
const_sv2-coverage 0.00% <ø> (ø)
error_handling-coverage 0.00% <ø> (ø)
framing_sv2-coverage 0.29% <ø> (ø)
jd_client-coverage 0.00% <ø> (ø)
jd_server-coverage 7.79% <ø> (ø)
job_declaration_sv2-coverage 0.00% <ø> (ø)
key-utils-coverage 2.39% <ø> (ø)
mining-coverage 2.51% <ø> (+0.01%) ⬆️
mining_device-coverage 0.00% <ø> (ø)
mining_proxy_sv2-coverage 0.70% <ø> (ø)
noise_sv2-coverage 4.35% <ø> (ø)
pool_sv2-coverage 1.38% <ø> (ø)
protocols 24.72% <ø> (ø)
roles 6.54% <ø> (ø)
roles_logic_sv2-coverage 8.08% <ø> (ø)
sv2_ffi-coverage 0.00% <ø> (ø)
template_distribution_sv2-coverage 0.00% <ø> (ø)
translator_sv2-coverage 9.60% <ø> (ø)
utils 25.13% <ø> (ø)
v1-coverage 2.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 20, 2024 •
edited
Loading

🐰 Bencher Report

Branchall-features-docs
Testbedsv1
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)		Upper Boundary
nanoseconds (ns)
(Limit %)
client-submit-serialize📈 view plot
🚷 view threshold		6,476.10
(-1.68%)		6,910.81
(93.71%)
client-submit-serialize-deserialize📈 view plot
🚷 view threshold		7,220.70
(-2.80%)		7,859.44
(91.87%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
🚷 view threshold		7,911.20
(-2.38%)		9,278.39
(85.26%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
🚷 view threshold		870.34
(+0.42%)		939.13
(92.67%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
🚷 view threshold		664.20
(-1.43%)		715.72
(92.80%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
🚷 view threshold		255.51
(+2.47%)		270.80
(94.35%)
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
🚷 view threshold		157.57
(+0.07%)		166.27
(94.77%)
client-sv1-get-submit📈 view plot
🚷 view threshold		6,221.70
(-2.23%)		6,755.37
(92.10%)
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
🚷 view threshold		275.25
(-2.35%)		323.80
(85.01%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
🚷 view threshold		706.38
(-2.71%)		775.74
(91.06%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
🚷 view threshold		581.96
(-1.22%)		625.54
(93.03%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
🚷 view threshold		206.61
(+0.09%)		223.80
(92.32%)
🐰 View full continuous benchmarking report in Bencher

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 20, 2024 •
edited
Loading

🐰 Bencher Report

Branchall-features-docs
Testbedsv2

🚨 1 Alert

BenchmarkMeasure
Units		ViewBenchmark Result
(Result Δ%)		Upper Boundary
(Limit %)
client_sv2_open_channel_serialize_deserializeL2 Accesses
accesses		📈 plot
🚨 alert (🔔)
🚷 threshold		92.00
(+22.12%)		89.10
(103.25%)
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
estimated cycles
(Result Δ%)		Upper Boundary
1e3 x estimated cycles
(Limit %)		InstructionsBenchmark Result
instructions
(Result Δ%)		Upper Boundary
instructions
(Limit %)		L1 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		L2 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		RAM AccessesBenchmark 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%)
🐰 View full continuous benchmarking report in Bencher

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 20, 2024 •
edited
Loading

🐰 Bencher Report

Branchall-features-docs
Testbedsv2
Click to view all benchmark results
BenchmarkLatencyBenchmark 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%)
🐰 View full continuous benchmarking report in Bencher

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 20, 2024 •
edited
Loading

🐰 Bencher Report

Branchall-features-docs
Testbedsv1
Click to view all benchmark results
BenchmarkEstimated CyclesBenchmark Result
estimated cycles
(Result Δ%)		Upper Boundary
1e3 x estimated cycles
(Limit %)		InstructionsBenchmark Result
instructions
(Result Δ%)		Upper Boundary
1e3 x instructions
(Limit %)		L1 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
1e3 x accesses
(Limit %)		L2 AccessesBenchmark Result
accesses
(Result Δ%)		Upper Boundary
accesses
(Limit %)		RAM AccessesBenchmark 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%)
🐰 View full continuous benchmarking report in Bencher

@Georges760
Copy link

Georges760 commented Dec 20, 2024 •
edited
Loading

My personal roadmap for no_std support is:

(going bottom-up in the dep graph)

@plebhash plebhash mentioned this pull request Dec 20, 2024
Open
@Georges760
Copy link

Actually, subprotocols crates only depends on binary_sv2 and const_sv2 which are already no_std compliant since #1230 , so I am able to do the subprotocols crates no_std PR without waiting for noise_sv2 and codec_sv2 PRs merge. Let's do that now.

@Georges760
Copy link

done : #1315

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.3.0
Development

Successfully merging this pull request may close these issues.

Need cargo doc --all-features test in CI/CD
2 participants
@plebhash @Georges760