Add HTML validator action #579
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,8 @@ | ||
| { | ||
| "ci": { | ||
| "url": ["http://localhost/", "http://localhost/install", "http://localhost/about", "http://localhost/community"], | ||
| "collect": { | ||
| "staticDistDir": "./_site" | ||
| } | ||
| } | ||
| } |
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,101 @@ | ||
| 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 | ||
|
|
||
| - 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. 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. 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. then maybe we could just add a comment like There was a problem hiding this comment. 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 | ||
|
|
||
| - name: Copy assets | ||
| run: cp -r assets _site/assets | ||
|
|
||
| # 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 --check-links-ignore "https://.*linkedin.com/.*" --check-links-ignore "/" | ||
|
|
||
| lighthouse: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| name: Check quality with Lighthouse | ||
| needs: [build] | ||
|
|
||
| steps: | ||
| - name: Fetch repository | ||
| 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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
noxusable 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
liveservebut that would be easy