Skip to content

docs: remove v3 from report format #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devpow112 merged 1 commit into from
May 25, 2026
+1 −64
Merged

docs: remove v3 from report format #847

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 1 addition & 64 deletions docs/report-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,69 +12,6 @@ stored in [AWS Timestream], please see [Storage Schema].

## Current

```json
{
"id": "<GUID>",
"version": 3,
"summary": {
"status": "<Must be 'passed' or 'failed'>",
"github": {
"organization": "<Non-empty string matching pattern '[A-Za-z0-9_.-]+'>",
"repository": "<Non-empty string matching pattern '[A-Za-z0-9_.-]+'>",
"workflow": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$'>",
"runId": "<Positive integer, can be 0>",
"runAttempt": "<Positive integer, must be 1 or greater>"
},
"git": {
"branch": "<Git branch this was generated for>",
"sha": "<Git SHA hash representing the commit this was generated for>"
},
"framework": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$>'",
"operatingSystem": "<Must be one of 'linux', 'windows' or 'mac'>",
"started": "<UTC timestamp>",
"duration": {
"total": "<Positive integer representing milliseconds, can be 0>"
},
"count": {
"passed": "<Positive integer, can be 0>",
"failed": "<Positive integer, can be 0>",
"skipped": "<Positive integer, can be 0>",
"flaky": "<Positive integer, can be 0>"
}
},
"details": [
{
"name": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$>'",
"status": "<Must be 'passed', 'skipped' or 'failed'>",
"location": {
"file": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$'>",
"line": "<Positive integer, can be 0, optional>",
"column": "<Positive integer, can be 0, optional>"
},
"browser": "<Can be 'chromium', 'chrome', 'firefox', 'webkit', 'safari' or 'edge', optional>",
"timeout": "<Positive integer representing milliseconds, can be 0, optional>",
"started": "<Timestamp in UTC time>",
"duration": {
"total": "<Positive integer representing milliseconds, can be 0>",
"final": "<Positive integer representing milliseconds, can be 0>"
},
"tool": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$', optional>",
"experience": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$', optional>",
"type": "<Non-empty string matching pattern '^(?!\\s).+(?<!\\s)$', optional>",
"retries": "<Positive integer, can be 0>",
"github": {
"codeowners": "<Array of strings starting with '@', optional>"
}
}
]
}
```

## Previous

<details>
<summary>Version 2</summary>

```json
{
"id": "<GUID>",
Expand Down Expand Up @@ -130,7 +67,7 @@ stored in [AWS Timestream], please see [Storage Schema].
}
```

</details>
## Previous

<details>
<summary>Version 1</summary>
Expand Down