Skip to content

ci: Add docs build to release-checks workflow#1684

Draft
CalMacCQ wants to merge 17 commits intomainfrom
cm/check_docs_build_on_release
Draft

ci: Add docs build to release-checks workflow#1684
CalMacCQ wants to merge 17 commits intomainfrom
cm/check_docs_build_on_release

Conversation

@CalMacCQ
Copy link
Copy Markdown
Contributor

(Work in progress)

Adds a c.i. job to the release checks to test building the sphinx docs upon release of the guppylang package. This should help us avoid inadvertently breaking the docs build and provide additional smoke tests to detect unintentional breaking changes.

closes #1670

I still need to make sure this interacts with releases in the right way.

@CalMacCQ CalMacCQ requested a review from a team as a code owner April 21, 2026 10:39
@CalMacCQ CalMacCQ requested a review from croyzor April 21, 2026 10:39
@CalMacCQ CalMacCQ marked this pull request as draft April 21, 2026 10:39
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 21, 2026

🐰 Bencher Report

Branchcm/check_docs_build_on_release
TestbedLinux
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
microseconds (µs)
(Result Δ%)
Upper Boundary
microseconds (µs)
(Limit %)
tests/benchmarks/test_big_array.py::test_big_array_check📈 view plot
🚷 view threshold
733,231.81 µs
(-27.66%)Baseline: 1,013,581.58 µs
1,064,260.65 µs
(68.90%)
tests/benchmarks/test_big_array.py::test_big_array_compile📈 view plot
🚷 view threshold
1,897,007.39 µs
(-10.74%)Baseline: 2,125,295.27 µs
2,231,560.03 µs
(85.01%)
tests/benchmarks/test_big_array.py::test_big_array_executable📈 view plot
🚷 view threshold
8,497,574.25 µs
(-1.33%)Baseline: 8,611,724.33 µs
9,042,310.55 µs
(93.98%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_check📈 view plot
🚷 view threshold
100,496.17 µs
(-11.97%)Baseline: 114,159.33 µs
119,867.30 µs
(83.84%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_compile📈 view plot
🚷 view threshold
211,579.86 µs
(-10.95%)Baseline: 237,598.15 µs
249,478.06 µs
(84.81%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_executable📈 view plot
🚷 view threshold
967,140.82 µs
(-25.92%)Baseline: 1,305,526.15 µs
1,370,802.46 µs
(70.55%)
tests/benchmarks/test_prelude.py::test_import_guppy📈 view plot
🚷 view threshold
45.31 µs
(-16.77%)Baseline: 54.44 µs
57.16 µs
(79.27%)
tests/benchmarks/test_queue_push_pop.py::test_queue_push_benchmark📈 view plot
🚷 view threshold
473,784.57 µs
(-0.30%)Baseline: 475,216.79 µs
498,977.63 µs
(94.95%)
tests/benchmarks/test_queue_push_pop.py::test_queue_push_pop_benchmark📈 view plot
🚷 view threshold
627,933.02 µs
(-0.04%)Baseline: 628,161.81 µs
659,569.90 µs
(95.20%)
🐰 View full continuous benchmarking report in Bencher

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 21, 2026

🐰 Bencher Report

Branchcm/check_docs_build_on_release
TestbedLinux
Click to view all benchmark results
Benchmarkhugr_bytesBenchmark Result
bytes x 1e3
(Result Δ%)
Upper Boundary
bytes x 1e3
(Limit %)
hugr_nodesBenchmark Result
nodes x 1e3
(Result Δ%)
Upper Boundary
nodes x 1e3
(Limit %)
tests/benchmarks/test_big_array.py::test_big_array_compile📈 view plot
🚷 view threshold
158.77 x 1e3
(0.00%)Baseline: 158.77 x 1e3
160.36 x 1e3
(99.01%)
📈 view plot
🚷 view threshold
6.64 x 1e3
(0.00%)Baseline: 6.64 x 1e3
6.71 x 1e3
(99.01%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_compile📈 view plot
🚷 view threshold
27.53 x 1e3
(0.00%)Baseline: 27.53 x 1e3
27.81 x 1e3
(99.01%)
📈 view plot
🚷 view threshold
1.07 x 1e3
(0.00%)Baseline: 1.07 x 1e3
1.08 x 1e3
(99.01%)
🐰 View full continuous benchmarking report in Bencher

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.47%. Comparing base (0483dfd) to head (714b02b).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1684      +/-   ##
==========================================
- Coverage   93.47%   93.47%   -0.01%     
==========================================
  Files         133      133              
  Lines       12701    12697       -4     
==========================================
- Hits        11872    11868       -4     
  Misses        829      829              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@maximilianruesch maximilianruesch changed the title ci: add docs build to release-checks workflow ci: Add docs build to release-checks workflow Apr 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Maintenance]: Build Guppy docs on release PRs

2 participants