Skip to content

Commit

Permalink
Validate links in changed markdown files
Browse files Browse the repository at this point in the history
New workflow gets the list of markdown files modified
and runs `mlc` Markup Line Checker tool on those file.

Signed-off-by: Sudan Landge <[email protected]>
  • Loading branch information
Sudan Landge committed Dec 22, 2023
1 parent 2913dac commit 4aeb5cf
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/markdown_link_checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check links in markdown documentation

on: pull_request

jobs:
test:
runs-on: ubuntu-latest
steps:
- name: "Checkout repository"
uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: "Validate links in updated markdown files"
run: |
git fetch origin
changedFiles=$(git diff origin/$GITHUB_BASE_REF.. --name-only)
mlc_installed=0
for file in $changedFiles; do
if [[ ".md" == ".${file##*.}" ]]; then
if [[ $mlc_installed == 0 ]]; then
cargo install mlc
mlc_installed=1
fi
echo ${file};
mlc $file
fi
done

0 comments on commit 4aeb5cf

Please sign in to comment.