hyperhawk/action.yml at main · dvdstelt/hyperhawk · 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
name: HyperHawk Link Checker
description: Scans markdown files for broken links and posts PR review comments
author: HyperHawk

inputs:
  token:
    description: GitHub token for API calls and posting PR comments
    required: true
    default: ${{ github.token }}
  files:
    description: Glob patterns for files to scan (comma-separated), defaults to all .md/.mdx
    required: false
    default: '**/*.md,**/*.mdx'
  check-external:
    description: Whether to check external HTTP links
    required: false
    default: 'true'
  check-same-org:
    description: Whether to check same-org GitHub links via API
    required: false
    default: 'true'
  check-relative:
    description: >
      Whether to check relative file links (../x.md, ./x.md, folder/x.md).
      Root-relative links (/x.md) are always checked.
    required: false
    default: 'true'
  relative-suggestion-depth:
    description: >
      Relative links that traverse this many directory levels or fewer are not
      given a root-relative conversion suggestion (0 = only same-folder links
      are exempt; 1 also exempts ../x.md and folder/x.md). Maximum 5; to skip
      relative-link checks entirely, set check-relative to false instead.
    required: false
    default: '0'
  ignore-patterns:
    description: Comma-separated list of URL patterns to ignore (regex)
    required: false
    default: ''
  timeout:
    description: Timeout in milliseconds for external link checks
    required: false
    default: '10000'
  concurrency:
    description: Number of concurrent link checks
    required: false
    default: '5'
  strict:
    description: Fail the workflow if broken links are found
    required: false
    default: 'false'
  skip-code-blocks:
    description: >
      When true, links inside fenced code blocks (``` or ~~~) are skipped
      and not checked.
    required: false
    default: 'false'
  report-only-changed:
    description: >
      When true, only report issues on lines that were changed in the PR.
      Broken links on unchanged lines are silently skipped instead of
      producing check warning annotations.
    required: false
    default: 'false'
  cross-repo-token:
    description: >
      Optional separate token used only for same-org GitHub link checks.
      Use a GitHub App token with Contents: Read permission to check links
      into private repositories. When omitted, the main token is used for
      all checks.
    required: false
    default: ''

branding:
  icon: link
  color: blue

runs:
  using: node20
  main: dist/index.js