Skip to content

Commit de7ce9e

Browse files
authored
Merge pull request #1923 from Kobzol/regression-pr-comment-change-text
Soften the language of regression comments on merged PRs
2 parents 2d792f4 + 13a4495 commit de7ce9e

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

site/src/github/comparison_summary.rs

+18-12
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ async fn summarize_run(
214214
if has_broken_benchmarks {
215215
" - BENCHMARK(S) FAILED"
216216
} else if is_regression {
217-
" - ACTION NEEDED"
217+
" - please read the text below"
218218
} else {
219219
" - no action needed"
220220
},
@@ -325,8 +325,8 @@ fn write_metric_summary(
325325
match visibility {
326326
DefaultMetricVisibility::Shown => {
327327
message.push_str(
328-
"This is a highly reliable metric that was used to determine the \
329-
overall result at the top of this comment.\n\n",
328+
"This is the most reliable metric that we have; it was used to determine the \
329+
overall result at the top of this comment. However, even this metric can sometimes exhibit noise.\n\n",
330330
);
331331
write_summary_table(&primary, &secondary, false, message);
332332
}
@@ -363,18 +363,24 @@ fn write_metric_summary(
363363

364364
fn master_run_body(is_regression: bool) -> String {
365365
if is_regression {
366-
"
367-
**Next Steps**: If you can justify the \
368-
regressions found in this perf run, please indicate this with \
369-
`@rustbot label: +perf-regression-triaged` along with \
370-
sufficient written justification. If you cannot justify the regressions \
371-
please open an issue or create a new PR that fixes the regressions, \
372-
add a comment linking to the newly created issue or PR, \
373-
and then add the `perf-regression-triaged` label to this PR.
366+
r#"
367+
Our benchmarks found a performance regression caused by this PR.
368+
This might be an actual regression, but it can also be just noise.
369+
370+
**Next Steps**:
371+
372+
- If the regression was expected or you think it can be justified,
373+
please write a comment with sufficient written justification, and add
374+
`@rustbot label: +perf-regression-triaged` to it, to mark the regression as triaged.
375+
- If you think that you know of a way to resolve the regression, try to create
376+
a new PR with a fix for the regression.
377+
- If you do not understand the regression or you think that it is just noise,
378+
you can ask the `@rust-lang/wg-compiler-performance` working group for help (members of this group
379+
were already notified of this PR).
374380
375381
@rustbot label: +perf-regression
376382
cc @rust-lang/wg-compiler-performance
377-
"
383+
"#
378384
} else {
379385
"
380386
@rustbot label: -perf-regression

0 commit comments

Comments
 (0)