LukeParke/slinky
1
0
Fork 0
mirror of https://github.com/LukeHagar/slinky.git synced 2025-12-06 04:21:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor input and output parameter names in action.yml for consistency

Browse Source
This commit is contained in:
Luke Hagar
2025-09-11 16:28:22 +00:00
parent eae00e0da1
commit b0c7ffe677
2 changed files with 14 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/workflows/example-slinky.yml vendored
View File

@@ -17,16 +17,6 @@ jobs:
- name: Run Slinky link checker - name: Run Slinky link checker
uses: ./ uses: ./
with:
path: .
patterns: "**/*"
concurrency: "16"
timeout: "10"
json-out: results.json
md-out: results.md
fail-on-failures: "true"
comment-pr: "true"
step-summary: "true"
- name: Upload results - name: Upload results
if: always() if: always()

28
action.yml
View File

@@ -22,27 +22,27 @@ inputs:
description: "HTTP timeout seconds" description: "HTTP timeout seconds"
required: false required: false
default: "10" default: "10"
json-out: json_out:
description: "Optional path to write JSON results" description: "Optional path to write JSON results"
required: false required: false
default: "results.json" default: "results.json"
md-out: md_out:
description: "Optional path to write Markdown report for PR comment" description: "Optional path to write Markdown report for PR comment"
required: false required: false
default: "results.md" default: "results.md"
repo-blob-base: repo_blob_base:
description: "Override GitHub blob base URL (https://github.com/<owner>/<repo>/blob/<sha>)" description: "Override GitHub blob base URL (https://github.com/<owner>/<repo>/blob/<sha>)"
required: false required: false
default: "" default: ""
fail-on-failures: fail_on_failures:
description: "Fail the job if any links fail" description: "Fail the job if any links fail"
required: false required: false
default: "true" default: "true"
comment-pr: comment_pr:
description: "If running on a PR, post a comment with the report" description: "If running on a PR, post a comment with the report"
required: false required: false
default: "true" default: "true"
step-summary: step_summary:
description: "Append the report to the GitHub Step Summary" description: "Append the report to the GitHub Step Summary"
required: false required: false
default: "true" default: "true"
@@ -56,17 +56,17 @@ runs:
INPUT_PATTERNS: ${{ inputs.patterns }} INPUT_PATTERNS: ${{ inputs.patterns }}
INPUT_CONCURRENCY: ${{ inputs.concurrency }} INPUT_CONCURRENCY: ${{ inputs.concurrency }}
INPUT_TIMEOUT: ${{ inputs.timeout }} INPUT_TIMEOUT: ${{ inputs.timeout }}
INPUT_JSON_OUT: ${{ inputs["json-out"] }} INPUT_JSON_OUT: ${{ inputs.json_out }}
INPUT_MD_OUT: ${{ inputs["md-out"] }} INPUT_MD_OUT: ${{ inputs.md_out }}
INPUT_REPO_BLOB_BASE: ${{ inputs["repo-blob-base"] }} INPUT_REPO_BLOB_BASE: ${{ inputs.repo_blob_base }}
INPUT_FAIL_ON_FAILURES: ${{ inputs["fail-on-failures"] }} INPUT_FAIL_ON_FAILURES: ${{ inputs.fail_on_failures }}
INPUT_COMMENT_PR: ${{ inputs["comment-pr"] }} INPUT_COMMENT_PR: ${{ inputs.comment_pr }}
INPUT_STEP_SUMMARY: ${{ inputs["step-summary"] }} INPUT_STEP_SUMMARY: ${{ inputs.step_summary }}
outputs: outputs:
json-path: json_path:
description: "Path to JSON results file" description: "Path to JSON results file"
md-path: md_path:
description: "Path to Markdown report file" description: "Path to Markdown report file"