Skip to content

Commit aca2f5f

Browse files
jhlegarretahjmjohnson
authored andcommitted
ENH: Add link checker GHA workflow file
Add link checker GHA workflow file: use the `lychee` action to check for broken links in Markdown, HTML, reStructuredText, and other files. Repository: https://github.com/lycheeverse/lychee-action Documentation: https://lychee.cli.rs/introduction/
1 parent 4a95585 commit aca2f5f

3 files changed

Lines changed: 29 additions & 1 deletion

File tree

.github/workflows/linkcheck.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Check links
2+
3+
on: [push, pull_request]
4+
5+
concurrency:
6+
group: ${{ github.workflow }}-${{ github.ref }}
7+
cancel-in-progress: true
8+
9+
jobs:
10+
linkcheck:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
- name: Check links
16+
id: lychee
17+
uses: lycheeverse/lychee-action@v2
18+
with:
19+
fail: true

.lychee.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Exclude patterns for links that are expected to fail in CI:
2+
# - Jinja2/Liquid template expressions in filenames
3+
# - insight-journal.org: historical journal now offline
4+
# - gnuplot.info: site exists but has TLS issues intermittently
5+
exclude = [
6+
"%7B%7B", # URL-encoded {{ in Jinja template file paths
7+
"insight-journal.org", # Historical journal, offline
8+
"www.gnuplot.info", # TLS certificate issues
9+
]

Documentation/Build/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ VV
242242
.. _ImageViewer: https://github.com/KitwareMedical/ImageViewer
243243
.. _ITKApps: https://github.com/InsightSoftwareConsortium/ITKApps
244244
.. _ITK-SNAP: http://www.itksnap.org/pmwiki/pmwiki.php
245-
.. _MITK: https://www.mitk.org/wiki/MITK
245+
.. _MITK: https://www.mitk.org/
246246
.. _Paraview: https://www.paraview.org/
247247
.. _Qt: https://www.qt.io/developers/
248248
.. _VTK: https://vtk.org/

0 commit comments

Comments
 (0)