Skip to content

Commit

Permalink
Check repo root and docs/docs separately
Browse files Browse the repository at this point in the history
  • Loading branch information
p-offtermatt committed Dec 1, 2023
1 parent c4ed126 commit 6c1b3be
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
25 changes: 14 additions & 11 deletions .github/workflows/linkchecker.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
name: Check Markdown links
on: push
jobs:
markdown-link-check:
Check markdown links in the repo root:
runs-on: ubuntu-latest
steps:
# Check out the latest version of the code
- uses: actions/checkout@v4

# Remove folders that we do not want to check.
# This is due to the markdown-link-check action
# not having an exclude parameter, see
# https://github.com/gaurav-nelson/github-action-markdown-link-check/issues/38
- name: Remove folders that we do not want to check
run: rm -rf .changelog

# Checks the status of hyperlinks in *.md files in docs/
# Checks the status of hyperlinks in *.md files in the repo root
- uses: gaurav-nelson/[email protected]
with:
config-file: .markdownlink_check_config.json
folder-path: '.'
max-depth: 1

Check markdown links in docs/docs:
runs-on: ubuntu-latest
steps:
# Check out the latest version of the code
- uses: actions/checkout@v4
# Checks the status of hyperlinks in *.md files in the docs/docs folder
- uses: gaurav-nelson/[email protected]
with:
folder-path: 'docs/docs'
7 changes: 0 additions & 7 deletions .markdownlink_check_config.json

This file was deleted.

0 comments on commit 6c1b3be

Please sign in to comment.