-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add workflow to run htmlproofer
- Loading branch information
Showing
1 changed file
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
name: Link Checker | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
ignore-urls: | ||
description: "Comma separated list of URLs to ignore" | ||
required: false | ||
default: "" | ||
type: string | ||
ignore-files: | ||
description: "Comma separated list of files to ignore" | ||
required: false | ||
default: "" | ||
type: string | ||
swap-urls: | ||
description: "Comma separated list of URLs to swap" | ||
required: false | ||
type: string | ||
default: >- | ||
(https\://github.com.*/master/.*)#.*:\1, | ||
(https\://github.com.*/main/.*)#.*:\1, | ||
(https\://github.com.*/blob/.*)#.*:\1 | ||
defaults: | ||
run: | ||
# Specify to ensure "pipefail and errexit" are set. | ||
# Ref: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#defaultsrunshell | ||
shell: bash | ||
|
||
jobs: | ||
htmlproofer: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: 3.1 | ||
bundler-cache: true | ||
|
||
- name: Build site | ||
run: | | ||
bunbdle exec jekyll build | ||
- name: Clean redirections | ||
run: | | ||
# Remove the redirect-files before link-check | ||
find _site/ -name \*.html | \ | ||
xargs grep -l "Click here if you are not redirected." | xargs rm | ||
- name: Clean code elements from html | ||
run: | | ||
# htmlproofer does not check links inside "<code>" and "<pre>" elements | ||
find _site -name \*.html | xargs sed -i.orig 's/<code[^>]*>//g; s/<\/code>//g; s/<pre[^>]*>//g; s/<\/pre>//g;' | ||
find _site -name \*.orig | xargs rm | ||
- name: check links | ||
env: | ||
LANG: "C.UTF-8" | ||
IGNORE_URLS: "${{ inputs.ignore-urls }}" | ||
IGNORE_FILES: "${{ inputs.ignore-files }}" | ||
SWAP_URLS: "${{ inputs.swap-urls }}" | ||
run: | | ||
bundle exec htmlproofer \ | ||
--assume-extension .html \ | ||
--no-enforce-https \ | ||
--no-check-external-hash \ | ||
--allow-missing-href \ | ||
--typhoeus '{"connecttimeout": 10, "timeout": 30, "accept_encoding": "zstd,br,gzip,deflate"}' \ | ||
--hydra '{"max_concurrency": 1}' \ | ||
--ignore-files "${IGNORE_FILES}" \ | ||
--ignore-urls "${IGNORE_URLS}" \ | ||
--swap-urls "${SWAP_URLS}" \ | ||
_site |