From 8dac698e92e7dc64d4a2ba8eed88389cb941728d Mon Sep 17 00:00:00 2001 From: Masaya Suzuki Date: Tue, 3 Dec 2024 09:09:27 +0900 Subject: [PATCH] Add fail_level and deduplicate fail_on_error --- .github/workflows/test.yml | 2 +- README.md | 9 +++++++++ action.yml | 10 ++++++++++ script.sh | 1 + 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c6dfb4d..7758acc 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -42,7 +42,7 @@ jobs: reporter: github-pr-review level: error filter_mode: file - fail_on_error: true + fail_level: any - name: check the exit code if: ${{ !success() }} run: echo 'The previous step should fail' && exit 1 diff --git a/README.md b/README.md index ae52173..c4718ce 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,19 @@ 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 afec862..61dec46 100644 --- a/action.yml +++ b/action.yml @@ -23,10 +23,19 @@ 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.' @@ -52,6 +61,7 @@ runs: INPUT_LEVEL: ${{ inputs.level }} INPUT_REPORTER: ${{ inputs.reporter }} INPUT_FILTER_MODE: ${{ inputs.filter_mode }} + INPUT_FAIL_LEVEL: ${{ inputs.fail_level }} INPUT_FAIL_ON_ERROR: ${{ inputs.fail_on_error }} INPUT_REVIEWDOG_FLAGS: ${{ inputs.reviewdog_flags }} INPUT_TYPOS_FLAGS: ${{ inputs.typos_flags }} diff --git a/script.sh b/script.sh index f3f1bac..bf2e34a 100755 --- a/script.sh +++ b/script.sh @@ -25,6 +25,7 @@ typos ${INPUT_TYPOS_FLAGS} --format json | -name="${INPUT_TOOL_NAME}" \ -reporter="${INPUT_REPORTER}" \ -filter-mode="${INPUT_FILTER_MODE}" \ + -fail-level="${INPUT_FAIL_LEVEL}" \ -fail-on-error="${INPUT_FAIL_ON_ERROR}" \ -level="${INPUT_LEVEL}" \ -tee \