Skip to content

Commit f85379a

Browse files
committed
docs: add missing log and report to --help
1 parent 93ba14e commit f85379a

4 files changed

Lines changed: 26 additions & 14 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- Add bashunit facade to enable custom assertions
77
- Document how to verify the `sha256sum` of the final executable
88
- Enable display execution time on MacOS with `SHOW_EXECUTION_TIME`
9-
- Add `-l|--log-junit <output.xml>` option
9+
- Add `-l|--log-junit <log.xml>` option
1010
- Add `-r|--report-html <report.html>` option
1111

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

docs/command-line.md

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

7373
## Logging
7474

75-
> `bashunit -l|--log-junit log-junit.xml`
75+
> `bashunit -l|--log-junit <out.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.
7878

@@ -82,6 +82,18 @@ Create a report XML file that follows the JUnit XML format and contains informat
8282
```
8383
:::
8484

85+
## Report
86+
87+
> `bashunit -r|--report-html <out.html>`
88+
89+
Create a report HTML file that contains information about the test results of your bashunit tests.
90+
91+
::: code-group
92+
```bash [Example]
93+
./bashunit ./tests --report-html report.html
94+
```
95+
:::
96+
8597
## Output
8698

8799
> `bashunit -s|--simple`
@@ -123,18 +135,6 @@ Running tests/functional/logic_test.sh
123135
```
124136
:::
125137

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-
138138
## Stop on failure
139139

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

src/console_header.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Options:
4242
-f|--filter <filter>
4343
Filters the tests to run based on the test name.
4444
45+
-l|--log-junit <out.xml>
46+
Create a report JUnit XML file that contains information about the test results.
47+
48+
-r|--report-html <out.html>
49+
Create a report HTML file that contains information about the test results.
50+
4551
-s|simple || -v|verbose
4652
Enables simplified or verbose output to the console.
4753

tests/acceptance/snapshots/bashunit_path_test_sh.test_bashunit_without_path_env_nor_argument.snapshot

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Options:
1616
-f|--filter <filter>
1717
Filters the tests to run based on the test name.
1818

19+
-l|--log-junit <out.xml>
20+
Create a report JUnit XML file that contains information about the test results.
21+
22+
-r|--report-html <out.html>
23+
Create a report HTML file that contains information about the test results.
24+
1925
-s|simple || -v|verbose
2026
Enables simplified or verbose output to the console.
2127

0 commit comments

Comments
 (0)