hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 09:22:43 +03:00
Code Issues Projects Releases Wiki Activity

ci: small formatting improvements to the benchmark output

Browse Source 
## Description

This PR does a few minor improvements to the formatting of the benchmark results:
- changes the title from `<h1>` to `<h2>`, consistent with other hasura-bot reports AFAICT
- concatenates lines together to allow for more natural line wrapping
- allows for the detailed report to be collapsed (but is open by default)

## Notes

The state of the report (open / closed) isn't persisted across refreshes, and I don't know if it's feasible for it to be. An alternative would be to, when generating a new report, edit the old ones to make them collapsed by default.

https://github.com/hasura/graphql-engine-mono/pull/1867

GitOrigin-RevId: 7021a05aebdebe4cc5738d567a6dcc3aaabd38bf
This commit is contained in:
Antoine Leblanc 2021-07-22 22:04:55 +01:00 committed by hasura-bot
parent 178fce0893
commit 3b3fee2fe0
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
server/benchmarks/fabfile.py vendored
View File

@ -443,24 +443,23 @@ def pretty_print_regression_report_github_comment(results, merge_base_pr, output
f = open(output_filename, "w")
def out(s): f.write(s+"\n")
out(f"# Benchmark Results")
out(f"## Benchmark Results")
out(f"")
out(f"The regression report below shows, for each benchmark, the **percent change** for")
out(f"different metrics, between the merge base (the changes from #{merge_base_pr})")
out(f"and this PR.")
out((f"The regression report below shows, for each benchmark, the **percent change** for "
f"different metrics, between the merge base (the changes from #{merge_base_pr}) and "
f"this PR. For advice on interpreting benchmarks, please see [benchmarks/README.md]"
f"(https://github.com/hasura/graphql-engine-mono/blob/main/server/benchmarks/README.md)."))
out(f"")
out(f"More significant regressions or improvements will be colored with `#b31d28` or `#22863a`, respectively.")
out(f"")
out(f"For advice on interpreting benchmarks, please see "+
"[benchmarks/README.md](https://github.com/hasura/graphql-engine-mono/blob/main/server/benchmarks/README.md)")
out(f"")
out(f"You can view the raw reports here:")
out(f"")
for benchmark_set_name, _ in results.items():
out(f"- **{benchmark_set_name}**: [these changes]({s3_url(benchmark_set_name)}) vs. "+
f"[merge base]({s3_url(benchmark_set_name, 'mono-pr-'+merge_base_pr)})")
out(f"- **{benchmark_set_name}**: [these changes]({s3_url(benchmark_set_name)}) vs. "
f"[merge base]({s3_url(benchmark_set_name, 'mono-pr-'+merge_base_pr)})")
out(f"")
out(f"These can be visualized with `graphql-bench`, [hosted here](https://hasura.github.io/graphql-bench/app/web-app/)")
out(f"These can be visualized with `graphql-bench`, [hosted here](https://hasura.github.io/graphql-bench/app/web-app/).")
out(f"")
out(f"<details open><summary>Click here for a detailed report.</summary>")
out(f"")
# Return what should be the first few chars of the line, which will detemine its styling:
@ -494,6 +493,7 @@ def pretty_print_regression_report_github_comment(results, merge_base_pr, output
out(f"{col(d)} {metric_name:<25}: {d:>6.1f}")
out( f"{col( )} ")
out( f"``` ") # END DIFF SYNTAX
out(f"</details>")
say(f"Wrote github comment to {REGRESSION_REPORT_COMMENT_FILENAME}")
f.close()