Skip to content

Commit edee40f

Browse files
committed
docs: add Report documentation
1 parent cdd8f02 commit edee40f

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- Document how to verify the `sha256sum` of the final executable
88
- Enable display execution time on MacOS with `SHOW_EXECUTION_TIME`
99
- Add `-l|--log-junit <output.xml>` option
10+
- Add `-r|--report-html <report.html>` option
1011

1112
## [0.13.0](https://github.com/TypedDevs/bashunit/compare/0.12.0...0.13.0) - 2024-06-23
1213

docs/command-line.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Filters the tests to be run based on the `test name`.
7171
:::
7272

7373
## Logging
74-
s
74+
7575
> `bashunit -l|--log-junit log-junit.xml`
7676
7777
Create a report XML file that follows the JUnit XML format and contains information about the test results of your bashunit tests.
@@ -82,7 +82,6 @@ Create a report XML file that follows the JUnit XML format and contains informat
8282
```
8383
:::
8484

85-
8685
## Output
8786

8887
> `bashunit -s|--simple`
@@ -124,6 +123,18 @@ Running tests/functional/logic_test.sh
124123
```
125124
:::
126125

126+
## Report
127+
128+
> `bashunit -r|--report-html report.html`
129+
130+
Create a report HTML file that contains information about the test results of your bashunit tests.
131+
132+
::: code-group
133+
```bash [Example]
134+
./bashunit ./tests --report-html report.html
135+
```
136+
:::
137+
127138
## Stop on failure
128139

129140
> `bashunit -S|--stop-on-failure`

0 commit comments

Comments
 (0)