Skip to content

Commit cec773a

Browse files
authored
Document new options (#37)
1 parent c290816 commit cec773a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ Run one of the following commands within your GithubAction workflow:
3434
vendor/bin/cs2pr /path/to/checkstyle-report.xml
3535
```
3636

37+
### Available Options
38+
39+
- `--graceful-warnings`: Don't exit with error codes if there are only warnings
40+
- `--colorize`: Colorize the output. Useful if the same lint script should be used locally on the command line and remote on Github Actions. With this option, errors and warnings are better distinguishable on the command line and the output is still compatible with Github Annotations
41+
42+
3743
## Pipe the output of another commmand
3844

3945
... works for __any__ command which produces a checkstyle-formatted report.

0 commit comments

Comments
 (0)