Skip to content

Commit 3771fe2

Browse files
committed
microbench-ci: remove description from github summary
The description on the summary is no longer needed, because we now add a label if a significant change was detected. Additionally, the legend is not needed, because there is no longer a scenario where we need to indicate only a possibly regression.
1 parent 6bf0691 commit 3771fe2

File tree

5 files changed

+0
-50
lines changed

5 files changed

+0
-50
lines changed

pkg/cmd/microbench-ci/report.go

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@ func (c CompareResults) writeJSONSummary(path string) error {
180180
// githubSummary creates a markdown summary of the comparison results.
181181
func (c CompareResults) githubSummary() (string, error) {
182182
buf := bytes.NewBuffer(nil)
183-
regressionDetected := false
184183
summaries := make([]GitHubData, 0, len(c))
185184
for _, cr := range c {
186185
finalStatus := NoChange
@@ -193,9 +192,6 @@ func (c CompareResults) githubSummary() (string, error) {
193192
if status > finalStatus {
194193
finalStatus = status
195194
}
196-
if status == Regressed {
197-
regressionDetected = true
198-
}
199195
return statusToDot(status)
200196
})
201197
data.BenchmarkStatus = statusToDot(finalStatus)
@@ -207,19 +203,13 @@ func (c CompareResults) githubSummary() (string, error) {
207203
if err != nil {
208204
return "", err
209205
}
210-
description := "No regressions detected!"
211-
if regressionDetected {
212-
description = "A regression has been detected, please investigate further!"
213-
}
214-
215206
err = tmpl.Execute(buf, struct {
216207
GitHubSummaryData []GitHubData
217208
Artifacts map[Revision]string
218209
Description string
219210
Commit string
220211
}{
221212
GitHubSummaryData: summaries,
222-
Description: description,
223213
Artifacts: map[Revision]string{
224214
Old: suite.artifactsURL(Old),
225215
New: suite.artifactsURL(New),

pkg/cmd/microbench-ci/template/github_summary.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,4 @@ gcloud storage cp {{$url}}\* {{$rev}}/
4040

4141
</details>
4242

43-
<details><summary>Legend</summary>
44-
45-
-**Neutral:** No significant performance change.
46-
- 🔴 **Regression:** Likely performance regression, requiring investigation.
47-
- 🟢 **Improvement:** Likely performance gain.
48-
49-
</details>
50-
51-
{{.Description}}
52-
5343
_built with commit: [{{.Commit}}](https://github.com/cockroachdb/cockroach/commit/{{.Commit}})_

pkg/cmd/microbench-ci/testdata/regression.txt

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -129,16 +129,6 @@ gcloud storage cp gs://cockroach-microbench-ci/artifacts/abcdef123//\* old/
129129

130130
</details>
131131

132-
<details><summary>Legend</summary>
133-
134-
- ⚪ **Neutral:** No significant performance change.
135-
- 🔴 **Regression:** Likely performance regression, requiring investigation.
136-
- 🟢 **Improvement:** Likely performance gain.
137-
138-
</details>
139-
140-
A regression has been detected, please investigate further!
141-
142132
_built with commit: [qwerty456](https://github.com/cockroachdb/cockroach/commit/qwerty456)_
143133
----
144134
----

pkg/cmd/microbench-ci/testdata/summary.txt

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,6 @@ gcloud storage cp gs://cockroach-microbench-ci/artifacts/abcdef123//\* old/
109109

110110
</details>
111111

112-
<details><summary>Legend</summary>
113-
114-
- ⚪ **Neutral:** No significant performance change.
115-
- 🔴 **Regression:** Likely performance regression, requiring investigation.
116-
- 🟢 **Improvement:** Likely performance gain.
117-
118-
</details>
119-
120-
No regressions detected!
121-
122112
_built with commit: [qwerty456](https://github.com/cockroachdb/cockroach/commit/qwerty456)_
123113
----
124114
----

pkg/cmd/microbench-ci/testdata/untracked_metric.txt

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -159,16 +159,6 @@ gcloud storage cp gs://cockroach-microbench-ci/artifacts/abcdef123//\* old/
159159

160160
</details>
161161

162-
<details><summary>Legend</summary>
163-
164-
- ⚪ **Neutral:** No significant performance change.
165-
- 🔴 **Regression:** Likely performance regression, requiring investigation.
166-
- 🟢 **Improvement:** Likely performance gain.
167-
168-
</details>
169-
170-
No regressions detected!
171-
172162
_built with commit: [qwerty456](https://github.com/cockroachdb/cockroach/commit/qwerty456)_
173163
----
174164
----

0 commit comments

Comments
 (0)