README.md

@@ -79,19 +79,19 @@ jobs:
 
 This action uses [lychee] for link checking.
 lychee arguments can be passed to the action via the `args` parameter.
-See [lychee's documentation][lychee-args] for all possible arguments.
 
 On top of that, the action also supports some additional arguments.
 
-| Argument      | Description                                                                      |
-| ------------- | -------------------------------------------------------------------------------- |
-| format        | Summary output format (markdown, json,...)                                       |
-| output        | Summary output file path                                                         |
-| fail          | Fail entire pipeline on error (i.e. when lychee exit code is not 0)              |
-| jobSummary    | Write Github job summary at the end of the job (written on Markdown output only) |
-| lycheeVersion | Overwrite the lychee version to be used                                          |
+| Argument      | Examples                | Description                                                                     |
+| ------------- | ----------------------- |-------------------------------------------------------------------------------- |
+| args          | `--cache`, `--insecure` | See [lychee's documentation][lychee-args] for all arguments and values          |
+| format        | `markdown`, `json`      | Summary output format                                                           |
+| output        | `lychee/results.md`     | Summary output file path                                                        |
+| fail          | `false`                 | Fail workflow run on error (i.e. when [lychee exit code][lychee-exit] is not 0) |
+| jobSummary    | `false`                 | Write Github job summary (on Markdown output only)                              |
+| lycheeVersion | `0.10.0`                | Overwrite the lychee version to be used                                         |
 
-See [action.yml](./action.yml) for a full list of supported arguments.
+See [action.yml](./action.yml) for a full list of supported arguments and their default values.
 
 ### Example of argument passing
 
@@ -194,6 +194,7 @@ at your option.
 
 [lychee]: https://github.com/lycheeverse/lychee
 [lychee-args]: https://github.com/lycheeverse/lychee#commandline-parameters
+[lychee-exit]: https://github.com/lycheeverse/lychee#exit-codes
 [troubleshooting]: https://github.com/lycheeverse/lychee/blob/master/docs/TROUBLESHOOTING.md
 [security]: https://francoisbest.com/posts/2020/the-security-of-github-actions
-[dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+[dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

action.yml

@@ -2,50 +2,55 @@ name: "Lychee Broken Link Checker"
 description: "Quickly check links in Markdown, HTML, and text files"
 inputs:
   args:
-    description: "lychee arguments"
+    description: "Lychee arguments (https://github.com/lycheeverse/lychee#commandline-parameters)"
     default: "--verbose --no-progress './**/*.md' './**/*.html'"
     required: false
   format:
-    description: "summary output format (e.g. json)"
+    description: "Summary output format (e.g. json)"
     default: "markdown"
     required: false
   output:
-    description: "summary output file path"
+    description: "Summary output file path"
     default: "lychee/out.md"
     required: false
   fail:
-    description: "fail entire pipeline on error (i.e. when lychee exit code is not 0)"
+    description: "Fail entire pipeline on error (i.e. when lychee exit code is not 0)"
     default: false
     required: false
   jobSummary:
-    description: "write Github job summary at the end of the job (written on Markdown output only)"
+    description: "Write Github job summary at the end of the job (written on Markdown output only)"
     default: true
     required: false
   lycheeVersion:
-    description: "use custom version of lychee link checker"
-    default: 0.10.0
+    description: "Use custom version of lychee link checker"
+    default: 0.10.1
     required: false
+outputs:
+  exit_code:
+    description: "The exit code returned from Lychee"
+    value: ${{ steps.lychee.outputs.exit_code }}
 runs:
   using: "composite"
   steps:
-    - name: install lychee
+    - name: Install lychee
       run: |
         curl -LO 'https://github.com/lycheeverse/lychee/releases/download/v${{ inputs.LYCHEEVERSION }}/lychee-v${{ inputs.LYCHEEVERSION }}-x86_64-unknown-linux-gnu.tar.gz'
         tar -xvzf lychee-v${{ inputs.LYCHEEVERSION }}-x86_64-unknown-linux-gnu.tar.gz
         chmod 755 lychee
         mv lychee /usr/local/bin/lychee
       shell: bash
-    - run: ${{ github.action_path }}/entrypoint.sh
+    - name: Run lychee
+      run: ${{ github.action_path }}/entrypoint.sh
+      id: lychee
       env:
-        #https://github.com/actions/runner/issues/665
+        # https://github.com/actions/runner/issues/665
         INPUT_GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
         INPUT_ARGS: ${{ inputs.ARGS }}
         INPUT_FORMAT: ${{ inputs.FORMAT }}
         INPUT_OUTPUT: ${{ inputs.OUTPUT }}
         INPUT_FAIL: ${{ inputs.FAIL }}
         INPUT_JOBSUMMARY: ${{ inputs.JOBSUMMARY }}
       shell: bash
-
 branding:
   icon: "external-link"
   color: "purple"