Skip to content

Commit a49764e

Browse files
committed
docs: various changes
1 parent be08551 commit a49764e

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -116,27 +116,6 @@ go-ctrf-json-reporter can be used in conjunction with gotestsum
116116
gotestsum --jsonfile gotestsum.json && go-ctrf-json-reporter < gotestsum.json
117117
```
118118

119-
## Test Object Properties
120-
121-
The test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):
122-
123-
| Name | Type | Required | Details |
124-
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |
125-
| `name` | String | Required | The name of the test. |
126-
| `status` | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |
127-
| `duration` | Number | Required | The time taken for the test execution, in milliseconds. |
128-
129-
## Troubleshoot
130-
131-
### Command Not Found
132-
133-
When running go-ctrf-json-reporter results in a "command not found" error this usually means that the Go bin directory is not in your system's PATH.
134-
135-
## Support Us
136-
137-
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.
138-
139-
140119
## Generate a CTRF JSON report in your own testing tool written in go
141120

142121
If you are writting your own testing tool and wish to generate a CTRF JSON report, you can use the `ctrf` package.
@@ -157,4 +136,24 @@ func runTests(destinationReportFile string) error {
157136
return report.WriteFile(destinationReportFile)
158137
}
159138

160-
```
139+
```
140+
141+
## Test Object Properties
142+
143+
The test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):
144+
145+
| Name | Type | Required | Details |
146+
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |
147+
| `name` | String | Required | The name of the test. |
148+
| `status` | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |
149+
| `duration` | Number | Required | The time taken for the test execution, in milliseconds. |
150+
151+
## Troubleshoot
152+
153+
### Command Not Found
154+
155+
When running go-ctrf-json-reporter results in a "command not found" error this usually means that the Go bin directory is not in your system's PATH.
156+
157+
## Support Us
158+
159+
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

0 commit comments

Comments
 (0)