Skip to content

Commit 9975774

Browse files
committed
describe output data format
1 parent b9c37f2 commit 9975774

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,19 @@ Currently supported sources:
1212
- `platform` (required): a string describing the platform
1313
- `output-file-path` (required): a path to a file containing the output of the benchmark tool
1414
- `data-out-path` (required): the path where the output of the action should be written
15+
16+
## Output data format
17+
18+
The output will be written to `data-out-path` in a standardized JSON format:
19+
```json
20+
[
21+
{
22+
"name": "My Custom Smaller Is Better Benchmark - Memory Used",
23+
"unit": "Megabytes",
24+
"platform": "ubuntu-latest",
25+
"value": 100,
26+
"range": "3",
27+
"extra": "Value for Tooltip: 25\nOptional Num #2: 100\nAnything Else!"
28+
}
29+
]
30+
```

0 commit comments

Comments
 (0)