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

chore: add CI check for up-to-date README.md #1473

Merged
merged 3 commits into from
Nov 7, 2024
Merged

chore: add CI check for up-to-date README.md #1473

merged 3 commits into from
Nov 7, 2024

Conversation

orhun
Copy link
Member

@orhun orhun commented Nov 6, 2024

No description provided.

@orhun orhun requested a review from a team as a code owner November 6, 2024 06:58
@orhun
Copy link
Member Author

orhun commented Nov 6, 2024

While working on this I also wondered if we should just do #![doc = include_str!("../../README.md")] for ratatui as well.

Also, currently there are no Linux binaries published for cargo-rdme which we can use in the CI to avoid cargo install. See orium/cargo-rdme#239

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 6, 2024

🐰 Bencher Report

Branchdocs/check_readme
Testbedubuntu-latest
🚨 14 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure
Units		ViewBenchmark Result
(Result Δ%)		Lower Boundary
(Limit %)		Upper Boundary
(Limit %)
barchart/render_horizontal/2048Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		179,930.00
(+11.12%)		175,568.67
(102.48%)
barchart/render_horizontal/256Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		96,111.00
(+20.04%)		90,570.79
(106.12%)
barchart/render_horizontal/64Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		90,008.00
(+22.80%)		83,811.15
(107.39%)
block/render_all_feature/100x50Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		19,875.00
(+91.77%)		13,734.37
(144.71%)
block/render_all_feature/200x50Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		37,171.00
(+103.36%)		24,262.48
(153.20%)
block/render_all_feature/256x256Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		206,830.00
(+140.17%)		122,915.00
(168.27%)
block/render_empty/100x50Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		14,658.00
(+159.28%)		8,639.78
(169.66%)
block/render_empty/200x50Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		29,322.00
(+162.11%)		16,992.64
(172.56%)
block/render_empty/256x256Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		192,360.00
(+165.33%)		109,066.75
(176.37%)
list/render/2048Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		363,760.00
(+25.96%)		359,476.22
(101.19%)
rect/rect_rows_collect/64Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		92.27
(+9.37%)		91.83
(100.48%)
table/render/64x2Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		389,350.00
(+13.41%)		383,090.34
(101.63%)
table/render_scroll_half/2048x2Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		700,260.00
(+7.02%)		693,869.65
(100.92%)
table/render_scroll_half/64x2Latency
nanoseconds (ns)		📈 plot
🚨 alert
🚷 threshold		265,190.00
(+16.53%)		258,996.94
(102.39%)
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
nanoseconds (ns)
(Result Δ%)		Upper Boundary
nanoseconds (ns)
(Limit %)
barchart/render/2048📈 view plot
🚷 view threshold		202,470.00
(+4.93%)		219,008.06
(92.45%)
barchart/render/256📈 view plot
🚷 view threshold		134,830.00
(+6.51%)		151,207.64
(89.17%)
barchart/render/64📈 view plot
🚷 view threshold		93,138.00
(+13.35%)		99,017.73
(94.06%)
barchart/render_grouped/2048📈 view plot
🚷 view threshold		346,440.00
(+2.12%)		373,540.70
(92.74%)
barchart/render_grouped/256📈 view plot
🚷 view threshold		145,310.00
(+6.44%)		161,414.04
(90.02%)
barchart/render_grouped/64📈 view plot
🚷 view threshold		135,180.00
(+8.48%)		149,514.38
(90.41%)
barchart/render_horizontal/2048📈 view plot
🚨 view alert
🚷 view threshold		179,930.00
(+11.12%)		175,568.67
(102.48%)
barchart/render_horizontal/256📈 view plot
🚨 view alert
🚷 view threshold		96,111.00
(+20.04%)		90,570.79
(106.12%)
barchart/render_horizontal/64📈 view plot
🚨 view alert
🚷 view threshold		90,008.00
(+22.80%)		83,811.15
(107.39%)
block/render_all_feature/100x50📈 view plot
🚨 view alert
🚷 view threshold		19,875.00
(+91.77%)		13,734.37
(144.71%)
block/render_all_feature/200x50📈 view plot
🚨 view alert
🚷 view threshold		37,171.00
(+103.36%)		24,262.48
(153.20%)
block/render_all_feature/256x256📈 view plot
🚨 view alert
🚷 view threshold		206,830.00
(+140.17%)		122,915.00
(168.27%)
block/render_empty/100x50📈 view plot
🚨 view alert
🚷 view threshold		14,658.00
(+159.28%)		8,639.78
(169.66%)
block/render_empty/200x50📈 view plot
🚨 view alert
🚷 view threshold		29,322.00
(+162.11%)		16,992.64
(172.56%)
block/render_empty/256x256📈 view plot
🚨 view alert
🚷 view threshold		192,360.00
(+165.33%)		109,066.75
(176.37%)
buffer/empty/16📈 view plot
🚷 view threshold		819.91
(+2.36%)		851.20
(96.32%)
buffer/empty/255📈 view plot
🚷 view threshold		226,030.00
(+0.90%)		231,647.17
(97.58%)
buffer/empty/64📈 view plot
🚷 view threshold		14,042.00
(+4.06%)		14,152.10
(99.22%)
buffer/filled/16📈 view plot
🚷 view threshold		816.27
(+2.41%)		838.08
(97.40%)
buffer/filled/255📈 view plot
🚷 view threshold		223,720.00
(+0.56%)		232,430.88
(96.25%)
buffer/filled/64📈 view plot
🚷 view threshold		13,788.00
(+2.69%)		14,097.13
(97.81%)
buffer/with_lines/16📈 view plot
🚷 view threshold		15,369.00
(+18.18%)		19,056.84
(80.65%)
buffer/with_lines/255📈 view plot
🚷 view threshold		15,510.00
(+20.05%)		19,074.84
(81.31%)
buffer/with_lines/64📈 view plot
🚷 view threshold		16,084.00
(+24.52%)		18,932.11
(84.96%)
line_render/Center/0📈 view plot
🚷 view threshold		4.03
(+14.37%)		4.84
(83.20%)
line_render/Center/10📈 view plot
🚷 view threshold		627.34
(+22.99%)		738.31
(84.97%)
line_render/Center/3📈 view plot
🚷 view threshold		295.78
(+14.50%)		342.29
(86.41%)
line_render/Center/4📈 view plot
🚷 view threshold		337.81
(+16.37%)		393.92
(85.76%)
line_render/Center/42📈 view plot
🚷 view threshold		837.77
(+26.58%)		991.96
(84.46%)
line_render/Center/6📈 view plot
🚷 view threshold		398.54
(+24.94%)		465.03
(85.70%)
line_render/Center/7📈 view plot
🚷 view threshold		453.54
(+25.73%)		531.10
(85.40%)
line_render/Left/0📈 view plot
🚷 view threshold		4.03
(+14.40%)		4.84
(83.14%)
line_render/Left/10📈 view plot
🚷 view threshold		591.62
(+27.14%)		698.81
(84.66%)
line_render/Left/3📈 view plot
🚷 view threshold		226.29
(+23.94%)		264.50
(85.55%)
line_render/Left/4📈 view plot
🚷 view threshold		241.16
(+24.01%)		280.97
(85.83%)
line_render/Left/42📈 view plot
🚷 view threshold		837.83
(+26.55%)		992.28
(84.44%)
line_render/Left/6📈 view plot
🚷 view threshold		387.94
(+26.79%)		454.32
(85.39%)
line_render/Left/7📈 view plot
🚷 view threshold		402.02
(+26.36%)		471.11
(85.33%)
line_render/Right/0📈 view plot
🚷 view threshold		4.02
(+14.32%)		4.84
(83.03%)
line_render/Right/10📈 view plot
🚷 view threshold		557.57
(+21.44%)		658.56
(84.66%)
line_render/Right/3📈 view plot
🚷 view threshold		271.02
(+10.03%)		313.15
(86.55%)
line_render/Right/4📈 view plot
🚷 view threshold		325.54
(+11.47%)		378.54
(86.00%)
line_render/Right/42📈 view plot
🚷 view threshold		837.51
(+26.52%)		992.74
(84.36%)
line_render/Right/6📈 view plot
🚷 view threshold		434.04
(+13.11%)		509.41
(85.20%)
line_render/Right/7📈 view plot
🚷 view threshold		490.49
(+13.99%)		574.17
(85.43%)
list/render/16384📈 view plot
🚷 view threshold		1,242,800.00
(+5.57%)		1,252,925.86
(99.19%)
list/render/2048📈 view plot
🚨 view alert
🚷 view threshold		363,760.00
(+25.96%)		359,476.22
(101.19%)
list/render/64📈 view plot
🚷 view threshold		234,490.00
(+40.14%)		239,367.87
(97.96%)
list/render_scroll_half/16384📈 view plot
🚷 view threshold		1,239,700.00
(+5.14%)		1,256,445.68
(98.67%)
list/render_scroll_half/2048📈 view plot
🚷 view threshold		356,270.00
(+21.79%)		364,992.60
(97.61%)
list/render_scroll_half/64📈 view plot
🚷 view threshold		160,770.00
(+41.26%)		161,625.00
(99.47%)
paragraph/new/2048📈 view plot
🚷 view threshold		260,290.00
(+2.51%)		264,553.96
(98.39%)
paragraph/new/64📈 view plot
🚷 view threshold		6,952.00
(+5.71%)		7,240.73
(96.01%)
paragraph/new/65535📈 view plot
🚷 view threshold		8,195,600.00
(-17.09%)		15,207,172.47
(53.89%)
paragraph/render/2048📈 view plot
🚷 view threshold		664,370.00
(+28.87%)		700,875.74
(94.79%)
paragraph/render/64📈 view plot
🚷 view threshold		621,370.00
(+30.50%)		661,109.13
(93.99%)
paragraph/render/65535📈 view plot
🚷 view threshold		1,724,600.00
(+6.27%)		1,924,377.95
(89.62%)
paragraph/render_scroll_full/2048📈 view plot
🚷 view threshold		619,070.00
(+29.52%)		681,256.24
(90.87%)
paragraph/render_scroll_full/64📈 view plot
🚷 view threshold		658,270.00
(+29.88%)		711,965.43
(92.46%)
paragraph/render_scroll_full/65535📈 view plot
🚷 view threshold		1,677,200.00
(+6.34%)		1,918,789.71
(87.41%)
paragraph/render_scroll_half/2048📈 view plot
🚷 view threshold		617,360.00
(+29.23%)		680,479.33
(90.72%)
paragraph/render_scroll_half/64📈 view plot
🚷 view threshold		663,620.00
(+29.75%)		714,616.24
(92.86%)
paragraph/render_scroll_half/65535📈 view plot
🚷 view threshold		1,682,100.00
(+6.04%)		1,902,940.65
(88.39%)
paragraph/render_wrap/2048📈 view plot
🚷 view threshold		320,420.00
(+26.19%)		323,671.63
(99.00%)
paragraph/render_wrap/64📈 view plot
🚷 view threshold		280,820.00
(+30.21%)		287,795.37
(97.58%)
paragraph/render_wrap/65535📈 view plot
🚷 view threshold		1,487,700.00
(+3.67%)		1,582,564.09
(94.01%)
paragraph/render_wrap_scroll_full/2048📈 view plot
🚷 view threshold		321,480.00
(+26.56%)		324,128.62
(99.18%)
paragraph/render_wrap_scroll_full/64📈 view plot
🚷 view threshold		281,810.00
(+30.63%)		287,489.53
(98.02%)
paragraph/render_wrap_scroll_full/65535📈 view plot
🚷 view threshold		1,483,400.00
(+3.23%)		1,582,662.01
(93.73%)
rect/rect_columns_collect/16📈 view plot
🚷 view threshold		39.08
(-0.09%)		40.29
(97.01%)
rect/rect_columns_collect/255📈 view plot
🚷 view threshold		290.87
(-0.63%)		294.82
(98.66%)
rect/rect_columns_collect/64📈 view plot
🚷 view threshold		90.16
(-0.11%)		91.69
(98.33%)
rect/rect_columns_iter/16📈 view plot
🚷 view threshold		10.71
(+6.29%)		11.05
(96.92%)
rect/rect_columns_iter/255📈 view plot
🚷 view threshold		84.16
(-0.13%)		84.80
(99.25%)
rect/rect_columns_iter/64📈 view plot
🚷 view threshold		26.22
(+0.02%)		26.52
(98.86%)
rect/rect_positions_collect/16x16📈 view plot
🚷 view threshold		293.92
(-0.24%)		297.45
(98.81%)
rect/rect_positions_collect/255x255📈 view plot
🚷 view threshold		60,869.00
(+0.29%)		61,016.14
(99.76%)
rect/rect_positions_collect/64x64📈 view plot
🚷 view threshold		3,871.40
(-0.26%)		3,908.07
(99.06%)
rect/rect_positions_iter/16x16📈 view plot
🚷 view threshold		248.27
(-0.25%)		250.32
(99.18%)
rect/rect_positions_iter/255x255📈 view plot
🚷 view threshold		61,612.00
(+1.35%)		61,983.87
(99.40%)
rect/rect_positions_iter/64x64📈 view plot
🚷 view threshold		3,817.60
(-0.02%)		3,836.12
(99.52%)
rect/rect_rows_collect/16📈 view plot
🚷 view threshold		39.71
(+4.84%)		39.90
(99.53%)
rect/rect_rows_collect/255📈 view plot
🚷 view threshold		292.24
(+10.70%)		292.44
(99.93%)
rect/rect_rows_collect/64📈 view plot
🚨 view alert
🚷 view threshold		92.27
(+9.37%)		91.83
(100.48%)
rect/rect_rows_iter/16📈 view plot
🚷 view threshold		7.77
(-0.61%)		7.95
(97.67%)
rect/rect_rows_iter/255📈 view plot
🚷 view threshold		80.51
(-0.18%)		81.07
(99.31%)
rect/rect_rows_iter/64📈 view plot
🚷 view threshold		21.53
(-0.27%)		21.86
(98.47%)
sparkline/render/2048📈 view plot
🚷 view threshold		131,330.00
(+8.98%)		160,328.10
(81.91%)
sparkline/render/256📈 view plot
🚷 view threshold		129,530.00
(+8.48%)		157,309.16
(82.34%)
sparkline/render/64📈 view plot
🚷 view threshold		41,265.00
(+8.41%)		50,637.31
(81.49%)
table/render/16384x2📈 view plot
🚷 view threshold		2,934,400.00
(+0.34%)		3,101,708.43
(94.61%)
table/render/16384x4📈 view plot
🚷 view threshold		5,396,600.00
(-5.62%)		6,635,834.39
(81.33%)
table/render/16384x8📈 view plot
🚷 view threshold		14,556,000.00
(-23.31%)		26,487,903.50
(54.95%)
table/render/2048x2📈 view plot
🚷 view threshold		681,200.00
(+4.75%)		687,174.31
(99.13%)
table/render/2048x4📈 view plot
🚷 view threshold		1,140,700.00
(+2.80%)		1,160,424.73
(98.30%)
table/render/2048x8📈 view plot
🚷 view threshold		1,849,700.00
(+1.38%)		1,922,574.40
(96.21%)
table/render/64x2📈 view plot
🚨 view alert
🚷 view threshold		389,350.00
(+13.41%)		383,090.34
(101.63%)
table/render/64x4📈 view plot
🚷 view threshold		558,800.00
(+6.62%)		566,544.29
(98.63%)
table/render/64x8📈 view plot
🚷 view threshold		634,370.00
(+4.67%)		660,386.47
(96.06%)
table/render_scroll_half/16384x2📈 view plot
🚷 view threshold		2,908,900.00
(-1.68%)		3,267,942.21
(89.01%)
table/render_scroll_half/16384x4📈 view plot
🚷 view threshold		5,518,400.00
(-7.70%)		7,145,868.19
(77.23%)
table/render_scroll_half/16384x8📈 view plot
🚷 view threshold		15,482,000.00
(-23.65%)		28,831,852.45
(53.70%)
table/render_scroll_half/2048x2📈 view plot
🚨 view alert
🚷 view threshold		700,260.00
(+7.02%)		693,869.65
(100.92%)
table/render_scroll_half/2048x4📈 view plot
🚷 view threshold		1,129,100.00
(+2.05%)		1,161,240.42
(97.23%)
table/render_scroll_half/2048x8📈 view plot
🚷 view threshold		1,832,300.00
(+1.29%)		1,911,975.10
(95.83%)
table/render_scroll_half/64x2📈 view plot
🚨 view alert
🚷 view threshold		265,190.00
(+16.53%)		258,996.94
(102.39%)
table/render_scroll_half/64x4📈 view plot
🚷 view threshold		370,070.00
(+8.03%)		372,919.82
(99.24%)
table/render_scroll_half/64x8📈 view plot
🚷 view threshold		419,990.00
(+5.63%)		435,220.21
(96.50%)
🐰 View full continuous benchmarking report in Bencher

@joshka
Copy link
Member

joshka commented Nov 6, 2024

While working on this I also wondered if we should just do #![doc = include_str!("../../README.md")] for ratatui as well.

The cargo-rdme approach is better IMO. Because:

  • intralinks are mapped to docs.rs links
  • heading levels are adjusted correctly
  • documentation is available when directly viewing the source

I was lazy with -core for this, focusing more on getting it done than on worrying about choosing the perfect tooling.

@orhun orhun merged commit e5e2316 into ratatui:main Nov 7, 2024
32 of 33 checks passed
This was referenced Feb 11, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshka joshka joshka approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@orhun @joshka