-
Notifications
You must be signed in to change notification settings - Fork 169
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.
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
chore(ci,docs): disable ToC in perf gh pages. #1930
Conversation
Signed-off-by: Federico Di Pierro <[email protected]>
/milestone 0.18.0 |
@@ -106,11 +106,11 @@ jobs: | |||
run: | | |||
python3 .github/generate_inline_svg_md.py trace_tests.svg | |||
mv out.md docs/unit_tests.md | |||
rm -rf out.md | |||
sed -i '1s/^/---\nhide:\n- toc\n---\n\n/' docs/unit_tests.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as for kernel testing matrixes.
Every PR will have a comment with the perf diff from master for multiple aspects, while on master the flamegraph are pushed to this github pages. | ||
|
||
Navigate to the perf reports on the left, or click these links: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Properly render bullet list.
Perf diff from master - unit tests
Perf diff from master - scap file
|
…them. Signed-off-by: Federico Di Pierro <[email protected]>
.github/generate_inline_svg_md.py
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Locally testing with mkdocs build
and mkdocs serve
; it seems like it is able to create a bundle site/
with proper link to svg images; we don't need to inline them anymore.
.github/workflows/pages.yml
Outdated
rm -rf out.md | ||
|
||
mv trace_tests.svg docs/trace_tests.svg | ||
echo '![unit tests](./trace_tests.svg)' > docs/unit_tests.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Create the unit_tests.md
file that references the svg image. Same below for scap file.
Perf diff from master - unit tests
Perf diff from master - scap file
|
/hold |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/approve
Signed-off-by: Federico Di Pierro <[email protected]>
rm -rf out.md | ||
|
||
mv trace_tests.svg docs/trace_tests.svg | ||
echo '<object data="../trace_tests.svg" type="image/svg+xml" id="unit_tests"></object>' > docs/unit_tests.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using the object tag, we have an interactive svg!
Perf diff from master - unit tests
Perf diff from master - scap file
|
/unhold |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Andreagit97, FedeDP, LucaGuerra The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind cleanup
Any specific area of the project related to this PR?
/area CI
Does this PR require a change in the driver versions?
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: