Skip to content

Markdown link check parameters #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 19, 2025
Merged

Markdown link check parameters #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33c3c68
support markdown check config
YanxuanLiu Aug 19, 2025
e0983ca
fix nits of value name
YanxuanLiu Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/markdown-link-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ jobs:

- name: Run Markdown Link Check
uses: NVIDIA/spark-rapids-common/markdown-link-check@main
with:
max-depth: -1
use-verbose-mode: 'yes'
44 changes: 41 additions & 3 deletions markdown-link-check/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,54 @@
name: 'Markdown Link Check'
description: 'Check markdown links'

inputs:
use-quiet-mode:
description: 'Specify yes to only show errors in output'
required: false
default: 'no'
use-verbose-mode:
description: 'Specify yes to show detailed HTTP status for checked links'
required: false
default: 'yes'
config-file:
description: 'Path to custom configuration file (relative to repository root)'
required: false
folder-path:
description: 'Comma-separated folders to check (default: entire repository)'
required: false
max-depth:
description: 'Directory traversal depth (-1 for unlimited)'
required: false
default: -1
check-modified-files-only:
description: 'Only check modified markdown files in PRs'
required: false
base-branch:
description: 'Comparison branch for modified files check'
required: false
Copy link

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The base-branch parameter was previously hardcoded to 'gh-pages' but now has no default value. Consider adding a default value or documenting the expected behavior when this parameter is not provided.

Suggested change
required: false
required: false
default: 'gh-pages'

Copilot uses AI. Check for mistakes.
file-extension:
description: 'File extension to check'
required: false
file-path:
description: 'Comma-separated specific files to check'
required: false

runs:
using: "composite"
steps:
- name: Run markdown link check
id: markdown-link-check
uses: tcort/github-action-markdown-link-check@v1
with:
max-depth: -1
use-verbose-mode: 'yes'
base-branch: 'gh-pages'
use-quiet-mode: ${{ inputs.use-quiet-mode }}
use-verbose-mode: ${{ inputs.use-verbose-mode }}
config-file: ${{ inputs.config-file }}
folder-path: ${{ inputs.folder-path }}
max-depth: ${{ inputs.max-depth }}
check-modified-files-only: ${{ inputs.check-modified-files-only }}
base-branch: ${{ inputs.base-branch }}
file-extension: ${{ inputs.file-extension }}
file-path: ${{ inputs.file-path }}

- name: Summarize results
shell: bash
Expand Down
Loading