Skip to content

Commit a3f320e

Browse files
authored
Merge pull request #467 from Remi-Gau/link_check
[MAINT] add link checker
2 parents f1d4c2b + 208d5f8 commit a3f320e

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

.github/workflows/check_md_links.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Check Markdown links
3+
4+
# checking for any dead links in markdown files
5+
6+
concurrency:
7+
group: ${{ github.workflow }}-${{ github.ref }}
8+
cancel-in-progress: true
9+
10+
on:
11+
push:
12+
branches:
13+
- main
14+
pull_request:
15+
branches: ['*']
16+
17+
jobs:
18+
markdown-link-check:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
23+
with:
24+
config-file: ./mlc_config.json
25+
folder-path: ./docs/
26+
use-verbose-mode: yes
27+
max-depth: -1
28+
file-path: ./README.md,

docs/01_introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
??? example "Tl;DR - Advantages of the current schema representation"
44
- Rich contexts for a questionnaire with JSON-LD rather than a "flat" csv file.
5-
- A single source of curated assessments from [ReproSchema Library](https://github.com/reproschema-library)
5+
- A single source of curated assessments from [ReproSchema Library](https://github.com/ReproNim/reproschema-library)
66
- Each `item` (i.e question), `activity` (i.e questionnaire), and `protocol`
77
(i.e set of questionnaires) provides unique and persistent identifiers.
88
- Versions of a given questionnaire can be tracked (e.g., PHQ-9, PHQ-8).

mlc_config.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"ignorePatterns": [
3+
{"pattern": "http://127.0.0.1:8000/"},
4+
{"pattern": "^https://jsonformatter.curiousconcept.com/"},
5+
{"pattern": "^http.*://schema.repronim.org/.*"},
6+
{"pattern": "^http://schema.org/version/2.0/"}
7+
8+
]
9+
}

0 commit comments

Comments
 (0)