-
Notifications
You must be signed in to change notification settings - Fork 183
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
Add HTML validator action #579
Changes from 9 commits
300c028
52a7964
366e00d
4dee8f5
d7f3474
1621100
6b84d67
1e77c7d
dcd0d7f
b501e41
e62e6b0
2ec8a19
0f200aa
b84786c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"ci": { | ||
"collect": { | ||
"staticDistDir": "./_site", | ||
"autodiscoverUrlBlocklist": [ | ||
"conduct.html" | ||
], | ||
"settings": { | ||
"skipAudits": ["canonical"] | ||
} | ||
}, | ||
"assert": { | ||
"assertions": { | ||
"categories:performance": ["error", { "minScore": 0.95 }], | ||
"categories:accessibility": ["error", { "minScore": 0.95 }], | ||
"categories:best-practices": ["error", { "minScore": 0.95 }], | ||
"categories:seo": ["error", { "minScore": 0.95 }] | ||
} | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
name: Test website | ||
|
||
on: | ||
push: | ||
branches: [ master ] | ||
pull_request: | ||
branches: [ master ] | ||
workflow_dispatch: | ||
|
||
concurrency: | ||
group: ${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
name: Build Jekyll site for testing | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Build the site in the Jekyll/builder container | ||
run: | | ||
docker run \ | ||
-v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \ | ||
jekyll/builder:latest /bin/bash -c "chmod -R 777 /srv/jekyll && jekyll build --future" | ||
|
||
- name: List result of Jekyll build | ||
run: | | ||
ls _site/ -l | ||
ls _site/assets -l | ||
|
||
# - name: Copy assets | ||
# run: cp -r assets _site/assets | ||
|
||
- name: Publish built site | ||
uses: actions/upload-artifact@v2 | ||
with: | ||
name: Built site ${{ github.run_number }} | ||
path: ./_site | ||
if-no-files-found: error | ||
|
||
validate: | ||
|
||
runs-on: ubuntu-latest | ||
name: Validate HTML | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could we add a comment somewhere just saying what we mean by "validate"? e.g., are we just doing some kind of basic integrity check? And would this not be captured by lighthouse already? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Some of them overlap (like By validate we mean run though W3C-sanctioned HTML integrity validator. In this case we use https://github.com/validator (https://validator.github.io/validator/) backend "Nu". It is featured on W3C: https://validator.w3.org/nu/ and https://validator.w3.org/docs/help.html#validation_basics describes what validation means to them. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. then maybe we could just add a comment like There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added link to that to README in e62e6b0 |
||
needs: [build] | ||
|
||
steps: | ||
- name: Fetch built site | ||
uses: actions/download-artifact@v2 | ||
with: | ||
name: Built site ${{ github.run_number }} | ||
path: ./_site | ||
|
||
# just to satisfy the `Cyb3r-Jak3/html5validator-action` action | ||
- name: Create dummy git repository | ||
run: git init | ||
|
||
- name: HTML5 Validator | ||
uses: Cyb3r-Jak3/html5validator-action@44696509d19bec6bd00e5ebf29bbeda320562aac | ||
with: | ||
root: _site/ | ||
|
||
check-links: | ||
|
||
runs-on: ubuntu-latest | ||
name: Check links | ||
needs: [build] | ||
|
||
steps: | ||
- name: Fetch built site | ||
uses: actions/download-artifact@v2 | ||
with: | ||
name: Built site ${{ github.run_number }} | ||
path: ./_site | ||
|
||
# TODO: we are not checking absolute links as pytest plugins does not support them | ||
- name: Check links | ||
run: | | ||
pip install pytest-check-links | ||
pytest _site/ --check-links \ | ||
krassowski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--check-links-ignore "https://.*linkedin.com/.*" \ | ||
--check-links-ignore "/" \ | ||
--check-links-ignore= ".github/images/netlify-preview.png" | ||
|
||
lighthouse: | ||
|
||
runs-on: ubuntu-latest | ||
name: Check quality with Lighthouse | ||
needs: [build] | ||
|
||
steps: | ||
- name: Fetch repository for `lighthouserc.json` | ||
uses: actions/checkout@v2 | ||
- name: Fetch built site | ||
uses: actions/download-artifact@v2 | ||
with: | ||
name: Built site ${{ github.run_number }} | ||
path: ./_site | ||
- name: Audit with Lighthouse | ||
uses: treosh/lighthouse-ci-action@v8 | ||
with: | ||
configPath: ".github/workflows/lighthouserc.json" | ||
temporaryPublicStorage: true | ||
uploadArtifacts: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have
nox
usable with this repository now, so we could just re-use that here via a verb likenox -s build
. That might reduce some redundancy.jupyter.github.io/noxfile.py
Lines 15 to 18 in 10cdc92
We'd need to update that so that there was a build verb that didn't also do
liveserve
but that would be easy