From 761f34f247af781c7f8ba75ae7f213ec82a8f59c Mon Sep 17 00:00:00 2001 From: Takayuki Nakata Date: Fri, 2 Dec 2022 22:24:38 +0900 Subject: [PATCH] Update README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index f29b779..e7352fb 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ jobs: ### `clippy_flags` Optional. clippy flags. (cargo clippy --color never -q --message-format json ``) +For example, `clippy_flags: -- -Dwarnings`. ### `tool_name` @@ -53,6 +54,17 @@ Optional. Working directory relative to the root directory. Optional. Reporter of reviewdog command [github-pr-check,github-pr-review]. It's same as `-reporter` flag of reviewdog. +#### github-pr-review +|`cargo clippy`|`cargo clippy -- -Dwarnings`| +|---|---| +|github-pr-review_warning|github-pr-review_error| + +#### github-pr-check +|`cargo clippy`|`cargo clippy -- -Dwarnings`| +|---|---| +|github-pr-check_warning|github-pr-check_error| + + ### `filter_mode` Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter].