Merge pull request #38 from UmbrellaDocs/stats

Add support for showing stats

Author: gaurav-nelson

Diff for: README.md

@@ -76,6 +76,13 @@ Default is `false`.
 (Optional) Path to your linkspector configuration file `.linkspector.yml`.
 For more details, see [Linkspector configuration](https://github.com/UmbrellaDocs/linkspector?tab=readme-ov-file#configuration).
 
+### `show_stats`
+
+(Optional) Show statistics about the checked links [true,false].
+Default is `false`.
+
+**Note:** Enabling the `show_stats` option causes Linkspector to run twice: once for reporting and again to collect statistics. Using this will increase the total run time of the action.
+
 ### Real-life usage samples
 
 Following is a list of some of the repositories which are using GitHub Action -

Diff for: action.yml

@@ -43,6 +43,10 @@ inputs:
     description: Specify the path for the Linkspector YML configuration file.
     required: true
     default: .linkspector.yml
+  show_stats:
+    description: Show statistics about the checked links.
+    required: false
+    default: "false"
 runs:
   using: composite
   steps:
@@ -76,6 +80,7 @@ runs:
         INPUT_FAIL_LEVEL: ${{ env.INPUT_FAIL_LEVEL }}
         INPUT_REVIEWDOG_FLAGS: ${{ inputs.reviewdog_flags }}
         INPUT_CONFIG_FILE: ${{ inputs.config_file }}
+        INPUT_SHOW_STATS: ${{ inputs.show_stats }}
 branding:
   icon: link-2
   color: blue

Diff for: script.sh

@@ -33,4 +33,11 @@ linkspector check -c "${INPUT_CONFIG_FILE}" -j |
     "${INPUT_REVIEWDOG_FLAGS}"
 exit_code=$?
 echo '::endgroup::'
+
+if [ "${INPUT_SHOW_STATS}" = "true" ]; then
+  echo '::group:: Running linkspector stats ...'
+  linkspector check -c "${INPUT_CONFIG_FILE}" -s || true
+  echo '::endgroup::'
+fi
+
 exit $exit_code