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

[MAINT] add link checker #467

Merged
merged 8 commits into from
Apr 23, 2024
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
28 changes: 28 additions & 0 deletions .github/workflows/check_md_links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Check Markdown links

# checking for any dead links in markdown files

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

on:
push:
branches:
- main
pull_request:
branches: ['*']

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: ./mlc_config.json
folder-path: ./docs/
use-verbose-mode: yes
max-depth: -1
file-path: ./README.md,
2 changes: 1 addition & 1 deletion docs/01_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

??? example "Tl;DR - Advantages of the current schema representation"
- Rich contexts for a questionnaire with JSON-LD rather than a "flat" csv file.
- A single source of curated assessments from [ReproSchema Library](https://github.com/reproschema-library)
- A single source of curated assessments from [ReproSchema Library](https://github.com/ReproNim/reproschema-library)
- Each `item` (i.e question), `activity` (i.e questionnaire), and `protocol`
(i.e set of questionnaires) provides unique and persistent identifiers.
- Versions of a given questionnaire can be tracked (e.g., PHQ-9, PHQ-8).
Expand Down
9 changes: 9 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"ignorePatterns": [
{"pattern": "http://127.0.0.1:8000/"},
{"pattern": "^https://jsonformatter.curiousconcept.com/"},
{"pattern": "^http.*://schema.repronim.org/.*"},
{"pattern": "^http://schema.org/version/2.0/"}
yibeichan marked this conversation as resolved.
Show resolved Hide resolved

]
}
Loading