mirror of
https://github.com/LukeHagar/slinky.git
synced 2025-12-06 04:21:20 +00:00
27718b695e
This commit updates the input names in action.yml to use hyphenated formats for better consistency and clarity. Additionally, the example workflow is modified to demonstrate the new input names and to showcase the functionality of disabling blocking failures and enabling PR comments.
62 lines
1.9 KiB
YAML
62 lines
1.9 KiB
YAML
name: "Slinky Link Checker"
|
|
description: "Slink through your repository looking for dead links"
|
|
author: "LukeHagar"
|
|
branding:
|
|
icon: "link"
|
|
color: "blue"
|
|
|
|
inputs:
|
|
targets:
|
|
description: "Comma-separated paths and patterns to scan. Can be directories, files, or glob patterns. Ex: docs/,api-specs/**/*.yaml,README.md"
|
|
required: false
|
|
default: "**/*"
|
|
concurrency:
|
|
description: "Maximum concurrent requests"
|
|
required: false
|
|
timeout:
|
|
description: "HTTP timeout seconds"
|
|
required: false
|
|
respect-gitignore:
|
|
description: "Respect .gitignore while scanning"
|
|
required: false
|
|
json-out:
|
|
description: "Optional path to write JSON results"
|
|
required: false
|
|
md-out:
|
|
description: "Optional path to write Markdown report for PR comment"
|
|
required: false
|
|
repo-blob-base:
|
|
description: "Override GitHub blob base URL (https://github.com/<owner>/<repo>/blob/<sha>)"
|
|
required: false
|
|
fail-on-failures:
|
|
description: "Fail the job if any links fail"
|
|
required: false
|
|
comment-pr:
|
|
description: "If running on a PR, post a comment with the report. Default: true (enabled when GITHUB_TOKEN is present)"
|
|
required: false
|
|
step-summary:
|
|
description: "Append the report to the GitHub Step Summary"
|
|
required: false
|
|
|
|
runs:
|
|
using: "docker"
|
|
image: "docker://ghcr.io/lukehagar/slinky:v1"
|
|
args: []
|
|
env:
|
|
INPUT_TARGETS: ${{ inputs.targets }}
|
|
INPUT_CONCURRENCY: ${{ inputs.concurrency }}
|
|
INPUT_TIMEOUT: ${{ inputs.timeout }}
|
|
INPUT_RESPECT_GITIGNORE: ${{ inputs.respect-gitignore }}
|
|
INPUT_JSON_OUT: ${{ inputs.json-out }}
|
|
INPUT_MD_OUT: ${{ inputs.md-out }}
|
|
INPUT_REPO_BLOB_BASE: ${{ inputs.repo-blob-base }}
|
|
INPUT_FAIL_ON_FAILURES: ${{ inputs.fail-on-failures }}
|
|
INPUT_COMMENT_PR: ${{ inputs.comment-pr }}
|
|
INPUT_STEP_SUMMARY: ${{ inputs.step-summary }}
|
|
|
|
outputs:
|
|
json_path:
|
|
description: "Path to JSON results file"
|
|
md_path:
|
|
description: "Path to Markdown report file"
|