From 160bcf7aef3defce06778431889c91ff84642106 Mon Sep 17 00:00:00 2001 From: haya14busa Date: Fri, 26 Jul 2024 22:01:55 +0900 Subject: [PATCH] Update README --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1ded0e87..c246035c 100644 --- a/README.md +++ b/README.md @@ -904,12 +904,11 @@ $ REVIEWDOG_SKIP_DOGHOUSE=true REVIEWDOG_GITHUB_API_TOKEN="" reviewdog -r ``` ## Exit codes -By default reviewdog will return `0` as exit code even if it finds errors. -If `-fail-on-error` flag is passed, reviewdog exits with `1` when at least one error was found/reported. +By default (`-fail-level=none`) reviewdog will return `0` as exit code even if it finds errors. +reviewdog will exit with code 1 with `-fail-level=[any,info,warning,error]` flag if it finds at least 1 issue with severity greater than or equal to the given level. This can be helpful when you are using it as a step in your CI pipeline and want to mark the step failed if any error found by linter. -See also `-level` flag for [github-pr-check/github-check](#reporter-github-checks--reportergithub-pr-check) reporters. -reviewdog will exit with `1` if reported check status is `failure` as well if `-fail-on-error=true`. +You can also use `-level` flag to configure default report revel. ## Filter mode reviewdog filter results by diff and you can control how reviewdog filter results by `-filter-mode` flag.