Skip to content

Commit

Permalink
docs: various changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Jun 7, 2024
1 parent be08551 commit a49764e
Showing 1 changed file with 21 additions and 22 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,27 +116,6 @@ go-ctrf-json-reporter can be used in conjunction with gotestsum
gotestsum --jsonfile gotestsum.json && go-ctrf-json-reporter < gotestsum.json
```

## Test Object Properties

The test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):

| Name | Type | Required | Details |
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |
| `name` | String | Required | The name of the test. |
| `status` | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |
| `duration` | Number | Required | The time taken for the test execution, in milliseconds. |

## Troubleshoot

### Command Not Found

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.

## Support Us

If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.


## Generate a CTRF JSON report in your own testing tool written in go

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

```
```

## Test Object Properties

The test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):

| Name | Type | Required | Details |
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |
| `name` | String | Required | The name of the test. |
| `status` | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |
| `duration` | Number | Required | The time taken for the test execution, in milliseconds. |

## Troubleshoot

### Command Not Found

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.

## Support Us

If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

0 comments on commit a49764e

Please sign in to comment.