Skip to content

Commit

Permalink
Improve issue template for flaky tests (apache#14116)
Browse files Browse the repository at this point in the history
- it currently causes a misinterpretation that the brackets should be left in the actual report
  - remove brackets from template
- fix label assignment
  • Loading branch information
lhotari authored Feb 4, 2022
1 parent 2324b89 commit 9497305
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions .github/ISSUE_TEMPLATE/flaky_test.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
---
name: Flaky test
about: Report a flaky test failure
title: 'Flaky-test: [test class].[test method]'
labels: component/test flaky-tests type/bug
title: 'Flaky-test: test_class.test_method'
labels: ["component/test", "flaky-tests"]
assignees: ''
---
<!---
Instructions for reporting a flaky test using this issue template:
1. Replace [test class] in title and body with the test class name
2. Replace [test method] in title and body with the test method that failed. Multiple methods are flaky, remove the content that refers to the test method.
1. Replace test_class in title and body with the short test class name WITHOUT the package name.
2. Replace test_method in title and body with the test method that failed. Multiple methods are flaky, remove the content that refers to the test method.
3. Replace "url here" with a url to an example failure. In the Github Actions workflow run logs, you can right click on the line number to copy a link to the line. Example of such url is https://github.com/apache/pulsar/pull/8892/checks?check_run_id=1531075794#step:9:377 . The logs are available for a limited amount of time (usually for a few weeks).
4. Replace "relevant parts of the exception stacktrace here" with the a few lines of the stack trace that shows at least the exception message and the line of test code where the stacktrace occurred.
5. Replace "full exception stacktrace here" with the full exception stacktrace from logs. This section will be hidden by default.
6. Remove all unused fields / content to unclutter the reported issue. Remove this comment too.
-->
[test class] is flaky. The [test method] test method fails sporadically.
test_class.test_method is flaky. It fails sporadically.

[example failure](url here)

```
[relevant parts of the exception stacktrace here]
```

<!-- optionally provide the full stacktrace ->
<details>
<summary>Full exception stacktrace</summary>
<code><pre>
full exception stacktrace here
</pre></code>
</details>
</details>

0 comments on commit 9497305

Please sign in to comment.