Skip to content

Commit

Permalink
add markdown link checker
Browse files Browse the repository at this point in the history
Signed-off-by: liyuan <[email protected]>
  • Loading branch information
nvliyuan committed Nov 23, 2023
1 parent e612d79 commit 6a472ba
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/markdown-links-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright (c) 2023, NVIDIA CORPORATION.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# A workflow to check if PR got broken hyperlinks
name: Check Markdown links

on:
pull_request:
types: [opened, synchronize, reopened]

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- name: work around permission issue
run: git config --global --add safe.directory /github/workspace
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
max-depth: -1
use-verbose-mode: 'yes'
check-modified-files-only: 'yes'
config-file: '.github/workflows/markdown-links-check/markdown-links-check-config.json'
base-branch: 'main'


Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"ignorePatterns": [
{
"pattern": "https://github.com/NVIDIA/spark-rapids-tools/issues/*"
},
{
"pattern": "http://localhost*"
},
{
"pattern": "https://www.nvidia.com/en-us/security/pgp-key"
}
],
"timeout": "15s",
"retryOn429": true,
"retryCount":30,
"aliveStatusCodes": [200, 403]
}

0 comments on commit 6a472ba

Please sign in to comment.