Skip to content
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.

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

Add github action for links checker for markdown files #207

Merged
merged 2 commits into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions .github/workflows/lint-markdown-links-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Lint Markdown Links PR
run-name: ${{github.event.pull_request.title}}
on: [ pull_request ]
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.mlc.config.json'
folder-path: '.'
max-depth: -1
check-modified-files-only: 'yes'
base-branch: ${{ github.base_ref }}
12 changes: 12 additions & 0 deletions .mlc.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"replacementPatterns": [
{
"_comment": "a replacement rule for all the in-repository references",
"pattern": "^/",
"replacement": "{{BASEURL}}/"
}
],
"timeout": "20s",
"retryCount": 5,
"fallbackRetryDelay": "30s"
}