Skip to content

Commit

Permalink
readme: switch to table for inputs
Browse files Browse the repository at this point in the history
  • Loading branch information
robherley committed Jul 24, 2022
1 parent 9e0e6ba commit 6a4c0a2
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@ Powered by [Job Summaries](https://github.blog/2022-05-09-supercharging-github-a

## Inputs

- `moduleDirectory` (optional): relative path to the directory containing the `go.mod` of the module you wish to test
- Default: `.`
- `testArguments` (optional): arguments to pass to `go test`, `-json` will be prepended automatically
- Default: `./...`
- `omitUntestedPackages` (optional): omit any go packages that don't have any tests from the summary output
- Default: `false`
- `omitPie` (optional): omit the pie chart from the summary output
- Default: `false`
| Input | Default | Description |
| - | - | - |
| moduleDirectory | `.` | relative path to the directory containing the `go.mod` of the module you wish to test |
| testArguments | `./...` | arguments to pass to `go test`, `-json` will be prepended automatically |
| omitUntestedPackages | `false` | omit any go packages that don't have any tests from the summary output |
| omitPie | `false` | omit the pie chart from the summary output

## Demo

Expand Down

0 comments on commit 6a4c0a2

Please sign in to comment.