Skip to content

Commit c38916b

Browse files
committed
chore: update GitHub report template and documentation
1 parent d2af50c commit c38916b

File tree

6 files changed

+11
-12
lines changed

6 files changed

+11
-12
lines changed

ctrf-reports/ctrf-report.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313
"start": 1722511783500,
1414
"stop": 1722511794528
1515
},
16-
"environment": {
17-
"appName": "My App",
18-
"appVersion": "1.0.0"
19-
},
2016
"tests": [
2117
{
2218
"name": "should be able to login",

dist/reports/github.hbs

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/report-showcase.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ Set the `summary-report` input to true in your workflow configuration:
5858
5959
Provides a test report that meets the [GitHub Design System](https://primer.style/guides/introduction). Specifically, it uses the GitHub icons and color scheme to acheive a native GitHub look and feel.
6060
61-
The report includes a summary of the test results and an expandable section for failed and flaky tests.
61+
The report includes a summary of the test results and an expandable section for failed, flaky, skipped, and pending tests.
62+
63+
it also includes context like git and action information.
6264
6365
### Usage
6466
@@ -75,7 +77,8 @@ Set the `github-report` input to true in your workflow configuration:
7577

7678
---
7779

78-
80+
![GitHub Report](../images/github.png)
81+
![GitHub Report](../images/github-failed.png)
7982

8083
### Overview
8184

images/github-failed.png

174 KB
Loading

images/github.png

116 KB
Loading

src/reports/github.hbs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@
1919

2020
![tests](https://ctrf.io/assets/github/beaker.svg) {{ctrf.summary.tests}} tests{{#if ctrf.summary.suites}} in {{ctrf.summary.suites}} suites{{/if}}
2121
![clock](https://ctrf.io/assets/github/clock.svg) {{formatDuration ctrf.summary.start ctrf.summary.stop}}
22+
{{#if ctrf.tool.name}}
23+
![tool](https://ctrf.io/assets/github/tools.svg) {{ctrf.tool.name}}
24+
{{/if}}
2225
{{#if ctrf.environment.appName}}
2326
{{#if ctrf.environment.appVersion}}
2427
![app](https://ctrf.io/assets/github/versions.svg) {{ctrf.environment.appName}} v{{ctrf.environment.appVersion}}
2528
{{else}}
2629
![app](https://ctrf.io/assets/github/versions.svg) {{ctrf.environment.appName}}
2730
{{/if}}
2831
{{/if}}
29-
{{#if ctrf.tool.name}}
30-
![tool](https://ctrf.io/assets/github/tools.svg) {{ctrf.tool.name}}
31-
{{/if}}
3232
{{#if ctrf.environment.buildName}}
3333
{{#if ctrf.environment.buildNumber}}
3434
{{#if ctrf.environment.buildUrl}}

0 commit comments

Comments
 (0)