chore: fix docs build - #821
Merged
SemyonSinchenko merged 4 commits intoApr 1, 2026
Merged
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aims to fix the docs build pipeline by generating a stable, docs-oriented benchmarks/jmh-result.json and updating Laika/docs templates to consume benchmark results keyed by algorithm.
Changes:
- Extend Laika benchmark JSON ingestion to key benchmark results by benchmarkName.algorithm (and keep legacy aliases for a subset).
- Update the benchmarks documentation page to reference the new config key structure.
- Add a dedicated dev/run_doc_benchmarks.py script and update the docs GitHub Actions workflow to use it.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file| File | Description |
|---|---|
| project/LaikaCustoms.scala | Adds algorithm-aware benchmark keys and legacy aliasing when building Laika config from JMH JSON. |
| docs/src/01-about/03-benchmarks.md | Updates template variables to the new benchmarkName.algorithm.* key paths. |
| dev/run_doc_benchmarks.py | New helper to run only the benchmarks needed for docs and merge outputs into benchmarks/jmh-result.json. |
| benchmarks/src/main/scala/org/graphframes/benchmarks/ConnectedComponentsBenchmark.scala | Expands benchmark parameterization to include randomized_contraction. |
| .github/workflows/docs.yml | Switches docs workflow benchmarking step to use the new Python helper script. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
Comment thread
project/LaikaCustoms.scala
Outdated
james-willis
reviewed
Apr 1, 2026
Comment thread
docs/src/01-about/03-benchmarks.md
james-willis
approved these changes
Apr 1, 2026
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
Reviewers
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.
What changes were proposed in this pull request?
Why are the changes needed?
It needs to be done :)