From 450f90087e8da2f90b1d37e29089d09cc626b4ef Mon Sep 17 00:00:00 2001 From: Masaya Suzuki Date: Tue, 3 Dec 2024 08:36:54 +0900 Subject: [PATCH 1/3] Add fail_level and deduplicate fail_on_error --- README.md | 8 ++++++++ action.yml | 8 ++++++++ entrypoint.sh | 1 + 3 files changed, 17 insertions(+) diff --git a/README.md b/README.md index d88ce85..133f28f 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,18 @@ inputs: Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added. default: 'added' + fail_level: + description: | + If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. + Possible values: [none,any,info,warning,error] + Default is `none`. + default: 'none' fail_on_error: description: | + Deprecated, use `fail_level` instead. Exit code for reviewdog when errors are found [true,false] Default is `false`. + deprecationMessage: Deprecated, use `fail_level` instead. default: 'false' reviewdog_flags: description: 'Additional reviewdog flags' diff --git a/action.yml b/action.yml index 687f6a8..c841f66 100644 --- a/action.yml +++ b/action.yml @@ -17,10 +17,18 @@ inputs: Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added. default: 'added' + fail_level: + description: | + If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. + Possible values: [none,any,info,warning,error] + Default is `none`. + default: 'none' fail_on_error: description: | + Deprecated, use `fail_level` instead. Exit code for reviewdog when errors are found [true,false] Default is `false`. + deprecationMessage: Deprecated, use `fail_level` instead. default: 'false' reviewdog_flags: description: 'Additional reviewdog flags' diff --git a/entrypoint.sh b/entrypoint.sh index 580b9db..6508be9 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -13,6 +13,7 @@ markdownlint ${INPUT_MARKDOWNLINT_FLAGS:-.} 2>&1 \ -name="markdownlint" \ -reporter="${INPUT_REPORTER:-github-pr-check}" \ -filter-mode="${INPUT_FILTER_MODE}" \ + -fail-level="${INPUT_FAIL_LEVEL}" \ -fail-on-error="${INPUT_FAIL_ON_ERROR}" \ -level="${INPUT_LEVEL}" \ ${INPUT_REVIEWDOG_FLAGS} || EXIT_CODE=$? From 95d9d62f57fde2f2c482a77053fa15ca4f7dec74 Mon Sep 17 00:00:00 2001 From: Masaya Suzuki Date: Tue, 3 Dec 2024 08:38:51 +0900 Subject: [PATCH 2/3] Add line break --- README.md | 3 ++- action.yml | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 133f28f..229c995 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ inputs: default: 'added' fail_level: description: | - If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. + If set to `none`, always use exit code 0 for reviewdog. + Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none,any,info,warning,error] Default is `none`. default: 'none' diff --git a/action.yml b/action.yml index c841f66..d7149be 100644 --- a/action.yml +++ b/action.yml @@ -19,7 +19,8 @@ inputs: default: 'added' fail_level: description: | - If set to `none`, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. + If set to `none`, always use exit code 0 for reviewdog. + Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none,any,info,warning,error] Default is `none`. default: 'none' From adf21b3b49ad328c783817ff170dede3259c2259 Mon Sep 17 00:00:00 2001 From: Masaya Suzuki Date: Tue, 3 Dec 2024 08:43:21 +0900 Subject: [PATCH 3/3] Add disable comment --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 229c995..3b1f4cd 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ code review experience. ## Inputs + ```yml inputs: github_token: @@ -50,6 +51,7 @@ inputs: description: "Options of markdownlint-cli command. Default: '.'" default: '.' ``` + ## Example usage