Skip to content

Commit 789b168

Browse files
committed
Document all options
1 parent 328e9a4 commit 789b168

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@ See https://staticcheck.io/docs/running-staticcheck/cli/#go for more information
8686

8787
Go build tags that get passed to Staticcheck via the `-tags` flag.
8888

89+
### `checks`
90+
91+
Value to pass to Staticcheck in the `-checks` flag. This doesn't
92+
normally need to be set and defaults to `"inherit"`.
93+
8994
### `install-go`
9095

9196
Whether the action should install the latest version of Go to install and run Staticcheck.
@@ -112,3 +117,18 @@ This is useful when dealing with multiple projects within one repository.
112117
Can be easily combined with a directory [`matrix`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix),
113118
see the advanced example above.
114119

120+
### `output-format`
121+
122+
Output format to use. This corresponds to Staticcheck's `-f` flag. Usually you
123+
will want to use the default (`"text"`), as this format creates annotations on
124+
pull requests. When combining multiple runs with `merge-files`, you want to use
125+
the `"binary"` format on the individual runs to create the inputs to the merge
126+
run.
127+
128+
### `output-file`
129+
130+
File to write Staticcheck's output to. Defaults to stdout.
131+
132+
### `merge-files`
133+
134+
A newline-separated list of files to pass to `staticcheck -merge`.

0 commit comments

Comments
 (0)