Skip to content

Commit cbf923f

Browse files
elichadelichad
committed
add html-proofer job to validate links
1 parent 8bc950f commit cbf923f

5 files changed

Lines changed: 399 additions & 10 deletions

File tree

‎.github/workflows/test.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "Build and Lint Site"
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
pull_request:
7+
branches: ["main"]
8+
9+
jobs:
10+
build-site:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 1
16+
17+
# dependencies
18+
- uses: ruby/setup-ruby@v1
19+
with:
20+
ruby-version: "3.3"
21+
- uses: actions/setup-node@v4
22+
with:
23+
node-version: "19"
24+
- name: Install dependencies
25+
working-directory: ./docs
26+
run: |
27+
sudo apt-get install -y build-essential zlib1g-dev
28+
gem install bundler
29+
bundle config path vendor/bundle
30+
bundle install
31+
32+
- name: Build the site
33+
run: bundle exec jekyll build --strict_front_matter
34+
35+
- name: Validate all links, enforce alt text
36+
# Example folders are ignored, as are HTML preview files.
37+
# Ignored URLs:
38+
# - https://w3id.org/ro/terms/workflow-run# terms, as the fragments don't resolve
39+
# - https://rdmkit.elixir-europe.org/federated_learning, as this page is not published on RDMkit yet (as of 2026-02-26)
40+
# Don't enforce https because we use http for schema.org
41+
run: |
42+
bundle exec htmlproofer \
43+
--ignore-files "/.*\/ro-crate-preview\.html/","/.\/example-*\/*" \
44+
--ignore-urls "/https://w3id.org/ro/terms/workflow-run/,/https://rdmkit.elixir-europe.org/federated_learning/"
45+
--enforce-https false \
46+
./_site
47+
48+
- name: Ensure no unexpected encoded HTML in output
49+
working-directory: ./docs
50+
run: |
51+
! fgrep -R 'lt;blockquote' _site
52+
53+
- name: Ensure no unexpected jekyll in output
54+
working-directory: ./docs
55+
run: |
56+
! fgrep -R 'site.pages' _site

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,3 +209,8 @@ cython_debug/
209209
marimo/_static/
210210
marimo/_lsp/
211211
__marimo__/
212+
213+
# Jekyll
214+
_site
215+
.sass-cache
216+
.jekyll-metadata

‎Gemfile‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
source "https://rubygems.org"
2+
3+
gem "github-pages", group: :jekyll_plugins
4+
gem "html-proofer", "~> 4.4.3"
5+
gem "nokogiri", ">=1.18.8" # used by html-proofer, https://github.com/ResearchObject/ro-crate/security/dependabot/53
6+
7+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
8+
gem "minima", "~> 2.0"
9+
10+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
11+
# and associated library.
12+
platforms :mingw, :x64_mingw, :mswin, :jruby do
13+
gem "tzinfo", ">= 1", "< 3"
14+
gem "tzinfo-data"
15+
end
16+
17+
# Performance-booster for watching directories on Windows
18+
gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
19+
20+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
21+
# do not have a Java counterpart.
22+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

‎Gemfile.lock‎

Lines changed: 306 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (8.1.2)
5+
base64
6+
bigdecimal
7+
concurrent-ruby (~> 1.0, >= 1.3.1)
8+
connection_pool (>= 2.2.5)
9+
drb
10+
i18n (>= 1.6, < 2)
11+
json
12+
logger (>= 1.4.2)
13+
minitest (>= 5.1)
14+
securerandom (>= 0.3)
15+
tzinfo (~> 2.0, >= 2.0.5)
16+
uri (>= 0.13.1)
17+
addressable (2.8.9)
18+
public_suffix (>= 2.0.2, < 8.0)
19+
base64 (0.3.0)
20+
bigdecimal (4.0.1)
21+
coffee-script (2.4.1)
22+
coffee-script-source
23+
execjs
24+
coffee-script-source (1.12.2)
25+
colorator (1.1.0)
26+
commonmarker (0.23.12)
27+
concurrent-ruby (1.3.6)
28+
connection_pool (3.0.2)
29+
csv (3.3.5)
30+
dnsruby (1.73.1)
31+
base64 (>= 0.2)
32+
logger (~> 1.6)
33+
simpleidn (~> 0.2.1)
34+
drb (2.2.3)
35+
em-websocket (0.5.3)
36+
eventmachine (>= 0.12.9)
37+
http_parser.rb (~> 0)
38+
ethon (0.15.0)
39+
ffi (>= 1.15.0)
40+
eventmachine (1.2.7)
41+
execjs (2.10.0)
42+
faraday (2.14.1)
43+
faraday-net_http (>= 2.0, < 3.5)
44+
json
45+
logger
46+
faraday-net_http (3.4.2)
47+
net-http (~> 0.5)
48+
ffi (1.17.3)
49+
ffi (1.17.3-x86_64-linux-gnu)
50+
forwardable-extended (2.6.0)
51+
gemoji (4.1.0)
52+
github-pages (232)
53+
github-pages-health-check (= 1.18.2)
54+
jekyll (= 3.10.0)
55+
jekyll-avatar (= 0.8.0)
56+
jekyll-coffeescript (= 1.2.2)
57+
jekyll-commonmark-ghpages (= 0.5.1)
58+
jekyll-default-layout (= 0.1.5)
59+
jekyll-feed (= 0.17.0)
60+
jekyll-gist (= 1.5.0)
61+
jekyll-github-metadata (= 2.16.1)
62+
jekyll-include-cache (= 0.2.1)
63+
jekyll-mentions (= 1.6.0)
64+
jekyll-optional-front-matter (= 0.3.2)
65+
jekyll-paginate (= 1.1.0)
66+
jekyll-readme-index (= 0.3.0)
67+
jekyll-redirect-from (= 0.16.0)
68+
jekyll-relative-links (= 0.6.1)
69+
jekyll-remote-theme (= 0.4.3)
70+
jekyll-sass-converter (= 1.5.2)
71+
jekyll-seo-tag (= 2.8.0)
72+
jekyll-sitemap (= 1.4.0)
73+
jekyll-swiss (= 1.0.0)
74+
jekyll-theme-architect (= 0.2.0)
75+
jekyll-theme-cayman (= 0.2.0)
76+
jekyll-theme-dinky (= 0.2.0)
77+
jekyll-theme-hacker (= 0.2.0)
78+
jekyll-theme-leap-day (= 0.2.0)
79+
jekyll-theme-merlot (= 0.2.0)
80+
jekyll-theme-midnight (= 0.2.0)
81+
jekyll-theme-minimal (= 0.2.0)
82+
jekyll-theme-modernist (= 0.2.0)
83+
jekyll-theme-primer (= 0.6.0)
84+
jekyll-theme-slate (= 0.2.0)
85+
jekyll-theme-tactile (= 0.2.0)
86+
jekyll-theme-time-machine (= 0.2.0)
87+
jekyll-titles-from-headings (= 0.5.3)
88+
jemoji (= 0.13.0)
89+
kramdown (= 2.4.0)
90+
kramdown-parser-gfm (= 1.1.0)
91+
liquid (= 4.0.4)
92+
mercenary (~> 0.3)
93+
minima (= 2.5.1)
94+
nokogiri (>= 1.16.2, < 2.0)
95+
rouge (= 3.30.0)
96+
terminal-table (~> 1.4)
97+
webrick (~> 1.8)
98+
github-pages-health-check (1.18.2)
99+
addressable (~> 2.3)
100+
dnsruby (~> 1.60)
101+
octokit (>= 4, < 8)
102+
public_suffix (>= 3.0, < 6.0)
103+
typhoeus (~> 1.3)
104+
html-pipeline (2.14.3)
105+
activesupport (>= 2)
106+
nokogiri (>= 1.4)
107+
html-proofer (4.4.3)
108+
addressable (~> 2.3)
109+
mercenary (~> 0.3)
110+
nokogiri (~> 1.13)
111+
parallel (~> 1.10)
112+
rainbow (~> 3.0)
113+
typhoeus (~> 1.3)
114+
yell (~> 2.0)
115+
zeitwerk (~> 2.5)
116+
http_parser.rb (0.8.1)
117+
i18n (1.14.8)
118+
concurrent-ruby (~> 1.0)
119+
jekyll (3.10.0)
120+
addressable (~> 2.4)
121+
colorator (~> 1.0)
122+
csv (~> 3.0)
123+
em-websocket (~> 0.5)
124+
i18n (>= 0.7, < 2)
125+
jekyll-sass-converter (~> 1.0)
126+
jekyll-watch (~> 2.0)
127+
kramdown (>= 1.17, < 3)
128+
liquid (~> 4.0)
129+
mercenary (~> 0.3.3)
130+
pathutil (~> 0.9)
131+
rouge (>= 1.7, < 4)
132+
safe_yaml (~> 1.0)
133+
webrick (>= 1.0)
134+
jekyll-avatar (0.8.0)
135+
jekyll (>= 3.0, < 5.0)
136+
jekyll-coffeescript (1.2.2)
137+
coffee-script (~> 2.2)
138+
coffee-script-source (~> 1.12)
139+
jekyll-commonmark (1.4.0)
140+
commonmarker (~> 0.22)
141+
jekyll-commonmark-ghpages (0.5.1)
142+
commonmarker (>= 0.23.7, < 1.1.0)
143+
jekyll (>= 3.9, < 4.0)
144+
jekyll-commonmark (~> 1.4.0)
145+
rouge (>= 2.0, < 5.0)
146+
jekyll-default-layout (0.1.5)
147+
jekyll (>= 3.0, < 5.0)
148+
jekyll-feed (0.17.0)
149+
jekyll (>= 3.7, < 5.0)
150+
jekyll-gist (1.5.0)
151+
octokit (~> 4.2)
152+
jekyll-github-metadata (2.16.1)
153+
jekyll (>= 3.4, < 5.0)
154+
octokit (>= 4, < 7, != 4.4.0)
155+
jekyll-include-cache (0.2.1)
156+
jekyll (>= 3.7, < 5.0)
157+
jekyll-mentions (1.6.0)
158+
html-pipeline (~> 2.3)
159+
jekyll (>= 3.7, < 5.0)
160+
jekyll-optional-front-matter (0.3.2)
161+
jekyll (>= 3.0, < 5.0)
162+
jekyll-paginate (1.1.0)
163+
jekyll-readme-index (0.3.0)
164+
jekyll (>= 3.0, < 5.0)
165+
jekyll-redirect-from (0.16.0)
166+
jekyll (>= 3.3, < 5.0)
167+
jekyll-relative-links (0.6.1)
168+
jekyll (>= 3.3, < 5.0)
169+
jekyll-remote-theme (0.4.3)
170+
addressable (~> 2.0)
171+
jekyll (>= 3.5, < 5.0)
172+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
173+
rubyzip (>= 1.3.0, < 3.0)
174+
jekyll-sass-converter (1.5.2)
175+
sass (~> 3.4)
176+
jekyll-seo-tag (2.8.0)
177+
jekyll (>= 3.8, < 5.0)
178+
jekyll-sitemap (1.4.0)
179+
jekyll (>= 3.7, < 5.0)
180+
jekyll-swiss (1.0.0)
181+
jekyll-theme-architect (0.2.0)
182+
jekyll (> 3.5, < 5.0)
183+
jekyll-seo-tag (~> 2.0)
184+
jekyll-theme-cayman (0.2.0)
185+
jekyll (> 3.5, < 5.0)
186+
jekyll-seo-tag (~> 2.0)
187+
jekyll-theme-dinky (0.2.0)
188+
jekyll (> 3.5, < 5.0)
189+
jekyll-seo-tag (~> 2.0)
190+
jekyll-theme-hacker (0.2.0)
191+
jekyll (> 3.5, < 5.0)
192+
jekyll-seo-tag (~> 2.0)
193+
jekyll-theme-leap-day (0.2.0)
194+
jekyll (> 3.5, < 5.0)
195+
jekyll-seo-tag (~> 2.0)
196+
jekyll-theme-merlot (0.2.0)
197+
jekyll (> 3.5, < 5.0)
198+
jekyll-seo-tag (~> 2.0)
199+
jekyll-theme-midnight (0.2.0)
200+
jekyll (> 3.5, < 5.0)
201+
jekyll-seo-tag (~> 2.0)
202+
jekyll-theme-minimal (0.2.0)
203+
jekyll (> 3.5, < 5.0)
204+
jekyll-seo-tag (~> 2.0)
205+
jekyll-theme-modernist (0.2.0)
206+
jekyll (> 3.5, < 5.0)
207+
jekyll-seo-tag (~> 2.0)
208+
jekyll-theme-primer (0.6.0)
209+
jekyll (> 3.5, < 5.0)
210+
jekyll-github-metadata (~> 2.9)
211+
jekyll-seo-tag (~> 2.0)
212+
jekyll-theme-slate (0.2.0)
213+
jekyll (> 3.5, < 5.0)
214+
jekyll-seo-tag (~> 2.0)
215+
jekyll-theme-tactile (0.2.0)
216+
jekyll (> 3.5, < 5.0)
217+
jekyll-seo-tag (~> 2.0)
218+
jekyll-theme-time-machine (0.2.0)
219+
jekyll (> 3.5, < 5.0)
220+
jekyll-seo-tag (~> 2.0)
221+
jekyll-titles-from-headings (0.5.3)
222+
jekyll (>= 3.3, < 5.0)
223+
jekyll-watch (2.2.1)
224+
listen (~> 3.0)
225+
jemoji (0.13.0)
226+
gemoji (>= 3, < 5)
227+
html-pipeline (~> 2.2)
228+
jekyll (>= 3.0, < 5.0)
229+
json (2.18.1)
230+
kramdown (2.4.0)
231+
rexml
232+
kramdown-parser-gfm (1.1.0)
233+
kramdown (~> 2.0)
234+
liquid (4.0.4)
235+
listen (3.10.0)
236+
logger
237+
rb-fsevent (~> 0.10, >= 0.10.3)
238+
rb-inotify (~> 0.9, >= 0.9.10)
239+
logger (1.7.0)
240+
mercenary (0.3.6)
241+
minima (2.5.1)
242+
jekyll (>= 3.5, < 5.0)
243+
jekyll-feed (~> 0.9)
244+
jekyll-seo-tag (~> 2.1)
245+
minitest (6.0.2)
246+
drb (~> 2.0)
247+
prism (~> 1.5)
248+
net-http (0.9.1)
249+
uri (>= 0.11.1)
250+
nokogiri (1.19.1-x86_64-linux-gnu)
251+
racc (~> 1.4)
252+
octokit (4.25.1)
253+
faraday (>= 1, < 3)
254+
sawyer (~> 0.9)
255+
parallel (1.27.0)
256+
pathutil (0.16.2)
257+
forwardable-extended (~> 2.6)
258+
prism (1.9.0)
259+
public_suffix (5.1.1)
260+
racc (1.8.1)
261+
rainbow (3.1.1)
262+
rb-fsevent (0.11.2)
263+
rb-inotify (0.11.1)
264+
ffi (~> 1.0)
265+
rexml (3.4.4)
266+
rouge (3.30.0)
267+
rubyzip (2.4.1)
268+
safe_yaml (1.0.5)
269+
sass (3.7.4)
270+
sass-listen (~> 4.0.0)
271+
sass-listen (4.0.0)
272+
rb-fsevent (~> 0.9, >= 0.9.4)
273+
rb-inotify (~> 0.9, >= 0.9.7)
274+
sawyer (0.9.3)
275+
addressable (>= 2.3.5)
276+
faraday (>= 0.17.3, < 3)
277+
securerandom (0.4.1)
278+
simpleidn (0.2.3)
279+
terminal-table (1.8.0)
280+
unicode-display_width (~> 1.1, >= 1.1.1)
281+
typhoeus (1.5.0)
282+
ethon (>= 0.9.0, < 0.16.0)
283+
tzinfo (2.0.6)
284+
concurrent-ruby (~> 1.0)
285+
unicode-display_width (1.8.0)
286+
uri (1.1.1)
287+
wdm (0.1.1)
288+
webrick (1.9.2)
289+
yell (2.2.2)
290+
zeitwerk (2.7.5)
291+
292+
PLATFORMS
293+
x86_64-linux
294+
295+
DEPENDENCIES
296+
github-pages
297+
html-proofer (~> 4.4.3)
298+
http_parser.rb (~> 0.6.0)
299+
minima (~> 2.0)
300+
nokogiri (>= 1.18.8)
301+
tzinfo (>= 1, < 3)
302+
tzinfo-data
303+
wdm (~> 0.1.0)
304+
305+
BUNDLED WITH
306+
2.6.8

0 commit comments

Comments
 (0)