Closed Ma11hewThomas closed 2 months ago
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 10 | 0 | 0 | 0 | 0 | 0 | 00:00:11 |
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
You can effortlessly generate custom test summaries and PR comments using your CTRF report, Handlebars and Markdown.
Let's start with the basics, a summary table that gives an overview of your test ctrf (you might have seen this one somewhere!). This table is straightforward yet powerful, helping you quickly communicate the state of your tests:
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
This table is generated by referencing various properties from your CTRF report, making it easy to create detailed and customized summaries.
In addition, you can leverage custom methods like countFlaky
and formatDuration
to enhance your summary:
Count of flaky tests: 3 Duration of execution: 00:00:11
Remember, you're not just writing markdownβyou're writing markdown enhanced with Handlebars, which means you can take full advantage of markdown's features while adding dynamic content.
Next, let's focus on generating a report specifically for failed tests. To do this, we'll iterate through the CTRF tests array and filter out the failed tests:
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
You might have noticed, this one is using a helper called eq
. You can use this for property comparisons directly within your template logic.
You can further enrich your summaries by tagging collaborators, adding tasks, and linking to important resources. Here's how:
You might want to notify someone specific, like @Ma11hewThomas.
If you have extensive details that might clutter your summary, you can use collapsible sections to hide and reveal information as needed:
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 10 | 0 | 0 | 0 | 0 | 0 | 00:00:11 |
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
You can effortlessly generate custom test summaries and PR comments using your CTRF report, Handlebars and Markdown.
Let's start with the basics, a summary table that gives an overview of your test ctrf (you might have seen this one somewhere!). This table is straightforward yet powerful, helping you quickly communicate the state of your tests:
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
This table is generated by referencing various properties from your CTRF report, making it easy to create detailed and customized summaries.
In addition, you can leverage custom methods like countFlaky
and formatDuration
to enhance your summary:
Count of flaky tests: 3 Duration of execution: 00:00:11
Remember, you're not just writing markdownβyou're writing markdown enhanced with Handlebars, which means you can take full advantage of markdown's features while adding dynamic content.
Next, let's focus on generating a report specifically for failed tests. To do this, we'll iterate through the CTRF tests array and filter out the failed tests:
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
You might have noticed, this one is using a helper called eq
. You can use this for property comparisons directly within your template logic.
You can further enrich your summaries by tagging collaborators, adding tasks, and linking to important resources. Here's how:
You might want to notify someone specific, like @Ma11hewThomas.
If you have extensive details that might clutter your summary, you can use collapsible sections to hide and reveal information as needed:
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 10 | 0 | 0 | 0 | 0 | 0 | 00:00:11 |
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
You can effortlessly generate custom test summaries and PR comments using your CTRF report, Handlebars and Markdown.
Let's start with the basics, a summary table that gives an overview of your test ctrf (you might have seen this one somewhere!). This table is straightforward yet powerful, helping you quickly communicate the state of your tests:
Tests π | Passed β | Failed β | Skipped βοΈ | Pending β³ | Other β | Flaky π | Duration β±οΈ |
---|---|---|---|---|---|---|---|
10 | 5 | 3 | 1 | 1 | 1 | 3 | 00:00:11 |
This table is generated by referencing various properties from your CTRF report, making it easy to create detailed and customized summaries.
In addition, you can leverage custom methods like countFlaky
and formatDuration
to enhance your summary:
Count of flaky tests: 3 Duration of execution: 00:00:11
Remember, you're not just writing markdownβyou're writing markdown enhanced with Handlebars, which means you can take full advantage of markdown's features while adding dynamic content.
Next, let's focus on generating a report specifically for failed tests. To do this, we'll iterate through the CTRF tests array and filter out the failed tests:
Name | Status | Failure Message |
---|---|---|
should display profile information | failed β | Assertion Failure: profile mismatch |
should fail to update profile on network failure | failed β | Network Timeout |
should fail to update profile on network failure | failed β | No failure message |
You might have noticed, this one is using a helper called eq
. You can use this for property comparisons directly within your template logic.
You can further enrich your summaries by tagging collaborators, adding tasks, and linking to important resources. Here's how:
You might want to notify someone specific, like @Ma11hewThomas.
If you have extensive details that might clutter your summary, you can use collapsible sections to hide and reveal information as needed:
With PR Comment - Run #477
β Some tests failed!
Github Actions Test Reporter CTRF