Skip to content

[Docs] Add annotation to build time plot (explain perf change) - #2079

Merged
mergify[bot] merged 4 commits into
Shamrock-code:mainfrom
tdavidcl:cursor/annotate-build-time-plot-27be
Aug 17, 2026
Merged

[Docs] Add annotation to build time plot (explain perf change)#2079
mergify[bot] merged 4 commits into
Shamrock-code:mainfrom
tdavidcl:cursor/annotate-build-time-plot-27be

Conversation

@tdavidcl

Copy link
Copy Markdown
Member

Add a dated marker on 2026-08-17 for forcing -j 4 on GitHub runners.

Add a dated marker on 2026-08-17 for forcing -j 4 on GitHub runners.
@github-actions

Copy link
Copy Markdown
Contributor

Thanks @tdavidcl for opening this PR!

You can do multiple things directly here:
1 - Comment pre-commit.ci run to run pre-commit checks.
2 - Comment pre-commit.ci autofix to apply fixes.
3 - Add label autofix.ci to fix authorship & pre-commit for every commit made.
4 - Add label light-ci to only trigger a reduced & faster version of the CI (need the full one before merge).
5 - Add label trigger-ci to create an empty commit to trigger the CI.

Once the workflow completes a message will appear displaying informations related to the run.

Also the PR gets automatically reviewed by gemini, you can:
1 - Comment /gemini review to trigger a review
2 - Comment /gemini summary for a summary
3 - Tag it using @gemini-code-assist either in the PR or in review comments on files

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 412b9dc8-d929-4ea4-87ac-8aafe081fbf3

📥 Commits

Reviewing files that changed from the base of the PR and between 3da4b71 and 0a58677.

📒 Files selected for processing (1)
  • doc/sphinx/source/_static/build_time_total.html

Included review availability: Your plan includes up to 1 review per rolling hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The build-time chart now accepts dated plot events. It renders each event as a theme-aware vertical marker with a labeled annotation and adjusts label placement near the series range end.

Changes

Build-time chart events

Layer / File(s) Summary
Configure dated chart events
doc/sphinx/source/_static/build_time_total.html
Adds an August 17, 2026 plot event labeled “force -j 4 in gh-runners” and includes event dates in the x-axis range.
Render event decorations
doc/sphinx/source/_static/build_time_total.html
Generates theme-aware event lines and annotations. Labels shift left when events are near the series range end.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 0a586

This documentation change adds a dated build-time annotation without introducing an actionable correctness or production risk; no merge-blocking risk remains beyond normal checks and review.

Possibly related PRs

Suggested reviewers: shamrock-code-admin

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change and its purpose: adding a build-time plot annotation to explain a performance change.
Description check ✅ Passed The description directly explains the dated marker and the GitHub runner change documented by the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Place the gh-runners marker at 2026-08-17T13:43:38Z and keep it
visible before later metrics samples arrive.
Keep the 13:43 UTC marker; let Plotly follow incoming metrics samples.
@github-actions

Copy link
Copy Markdown
Contributor

Workflow report

workflow report corresponding to commit 001957a
Commiter email is [email protected]

Light CI is enabled (the default for pull requests). This will only run the basic tests and not the full tests.
Full CI runs if the full-ci label is set, or automatically on Mergify merge-queue branches (mergify/merge-queue/*).
The merge gate job "on PR / all" is skipped in this case. Queue entry uses "on PR / all_light"; full CI runs in the merge queue.

Pre-commit check report

Pre-commit check: ✅

trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check for merge conflicts................................................Passed
check that executables have shebangs.....................................Passed
check that scripts with shebangs are executable..........................Passed
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check for broken symlinks................................................Passed
check yaml...............................................................Passed
detect private key.......................................................Passed
No-tabs checker..........................................................Passed
Tabs remover.............................................................Passed
cmake-format.............................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
ruff check...............................................................Passed
ruff format..............................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................Passed
No ssh in git submodules remote..........................................Passed
No UTF-8 in files (except for authors)...................................Passed

Test pipeline can run.

Clang-tidy diff report

No relevant changes found.
Well done!

You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review.

Doxygen diff with main

Removed warnings : 0
New warnings : 0
Warnings count : 8183 → 8183 (0.0%)

Detailed changes :

@tdavidcl

Copy link
Copy Markdown
Member Author

@Mergifyio queue

@mergify

mergify Bot commented Aug 17, 2026

Copy link
Copy Markdown

Merge Queue Status

This pull request spent 2 hours 1 minute 44 seconds in the queue, including 1 hour 51 minutes 6 seconds running CI.

Required conditions to merge
  • check-success = all

@mergify mergify Bot added the queued label Aug 17, 2026
@mergify
mergify Bot merged commit 79e0025 into Shamrock-code:main Aug 17, 2026
36 checks passed
@mergify mergify Bot removed the queued label Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants