Merge pull request #37 from Bilka2/use-fail-level

Use fail_level instead of deprecated fail_on_error

.github/workflows/test.yml

@@ -46,7 +46,7 @@ jobs:
           level: error
           locale: "US"
           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

README.md

@@ -43,18 +43,19 @@ inputs:
     description: 'Report level for reviewdog [info,warning,error].'
     default: 'error'
   reporter:
-    description: 'Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].'
+    description: 'Reporter of reviewdog command [github-check,github-pr-review,github-pr-check,sarif].'
     default: 'github-check'
   filter_mode:
     description: |
       Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
-      Default is added.
+      Default is `added` except that sarif reporter uses `nofilter`.
     default: 'added'
-  fail_on_error:
+  fail_level:
     description: |
-      Exit code for reviewdog when errors are found [true,false].
-      Default is `false`.
-    default: 'false'
+      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'
   reviewdog_flags:
     description: 'Additional reviewdog flags.'
     default: ''

action.yml

@@ -24,11 +24,12 @@ inputs:
       Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
       Default is `added` except that sarif reporter uses `nofilter`.
     default: ''
-  fail_on_error:
+  fail_level:
     description: |
-      Exit code for reviewdog when errors are found [true,false].
-      Default is `false`.
-    default: 'false'
+      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'
   reviewdog_flags:
     description: 'Additional reviewdog flags.'
     default: ''
@@ -56,7 +57,7 @@ runs:
         INPUT_LEVEL: ${{ inputs.level }}
         INPUT_REPORTER: ${{ inputs.reporter }}
         INPUT_FILTER_MODE: ${{ inputs.filter_mode }}
-        INPUT_FAIL_ON_ERROR: ${{ inputs.fail_on_error }}
+        INPUT_FAIL_LEVEL: ${{ inputs.fail_level }}
         INPUT_REVIEWDOG_FLAGS: ${{ inputs.reviewdog_flags }}
         INPUT_OUTPUT_DIR: ${{ inputs.output_dir }}
         INPUT_LOCALE: ${{ inputs.locale }}

script.sh

@@ -26,7 +26,7 @@ misspell -locale="${INPUT_LOCALE}" . |
     -name="${INPUT_TOOL_NAME}" \
     -reporter="${INPUT_REPORTER}" \
     -filter-mode="${INPUT_FILTER_MODE}" \
-    -fail-on-error="${INPUT_FAIL_ON_ERROR}" \
+    -fail-level="${INPUT_FAIL_LEVEL}" \
     -level="${INPUT_LEVEL}" \
     ${INPUT_REVIEWDOG_FLAGS} |
   tee "${INPUT_OUTPUT_DIR}/${OUTPUT_FILE_NAME}"