link-checker/action.yml at main · academic/link-checker · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
name: Markdown Link Checker
description: Check Markdown links for 404, redirect to 404, 402/403, and 5xx statuses using Bash.
author: academic

inputs:
  report-file:
    description: Output Markdown report path.
    required: false
    default: link-check-results.md
  fail-on-issue:
    description: Fail action when matching issues are found.
    required: false
    default: "true"
  user-agent:
    description: User-Agent header value used by curl.
    required: false
    default: markdown-link-check-github-action

outputs:
  checked-count:
    description: Number of URLs checked.
    value: ${{ steps.check.outputs.checked-count }}
  issue-count:
    description: Number of matching issues found.
    value: ${{ steps.check.outputs.issue-count }}
  report-file:
    description: Path to generated report file.
    value: ${{ steps.check.outputs.report-file }}

runs:
  using: composite
  steps:
    - id: check
      shell: bash
      run: |
        chmod +x "$GITHUB_ACTION_PATH/scripts/check-markdown-links.sh"
        "$GITHUB_ACTION_PATH/scripts/check-markdown-links.sh" \
          "${{ inputs.report-file }}" \
          "${{ inputs.fail-on-issue }}" \
          "${{ inputs.user-agent }}"