privacyguides.org/.github/workflows/tests.yml

239 lines
7.5 KiB
YAML
Raw Normal View History

2021-05-01 17:24:18 -04:00
name: Code tests
2021-05-01 23:59:01 -04:00
on:
push:
branches:
- main
pull_request:
branches:
- main
2021-05-01 17:24:18 -04:00
env:
FONTAWESOME_NPM_AUTH_TOKEN: ${{ secrets.FONTAWESOME_NPM_AUTH_TOKEN }}
jobs:
deps:
name: "Dependency Install"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
2021-05-01 23:59:01 -04:00
- name: Cache node modules
uses: actions/cache@v3
2021-05-01 23:59:01 -04:00
with:
path: ~/.npm
key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-npm-
- uses: actions/setup-node@v3
2021-05-01 17:24:18 -04:00
with:
node-version: '14'
- run: npm install
2021-05-02 15:43:11 -04:00
- run: tar cvf node_modules.tar node_modules
- name: Upload node_modules for Jekyll build
uses: actions/upload-artifact@v2
with:
name: node_modules
path: node_modules.tar
2021-05-01 17:24:18 -04:00
build:
name: "Jekyll Build"
runs-on: ubuntu-latest
2021-05-02 15:43:11 -04:00
needs: deps
2021-05-01 17:24:18 -04:00
steps:
- uses: actions/checkout@v3
2021-05-01 17:24:18 -04:00
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- uses: actions/setup-node@v3
2021-05-01 17:24:18 -04:00
with:
node-version: '14'
2021-05-01 23:59:01 -04:00
- name: Cache Jekyll build
uses: actions/cache@v3
2021-05-01 23:59:01 -04:00
with:
path: |
.jekyll-cache
.sass-cache
key: ${{ runner.os }}-jekyll-${{ hashFiles('**/*.??m[ld]') }}
restore-keys: |
${{ runner.os }}-jekyll-
2021-05-02 15:43:11 -04:00
- name: Set Date and Time
run: |
sed -i "s/^ date:.*$/ date: $(TZ=UTC date "+%Y-%m-%d")/" _config.yml
sed -i "s/^ time:.*$/ time: $(TZ=UTC date "+%H:%M:%S %Z")/" _config.yml
- name: Download node_modules
uses: actions/download-artifact@v2
with:
name: node_modules
- run: tar xvf node_modules.tar
- name: Generate Website
run: npm run build
- run: tar cvf site.tar _site
- name: Upload generated Jekyll site
uses: actions/upload-artifact@v2
with:
name: generated-site
path: site.tar
2021-05-01 17:24:18 -04:00
link:
2021-05-01 20:54:23 -04:00
name: "Broken Hyperlinks (Internal)"
2021-05-01 17:24:18 -04:00
runs-on: ubuntu-latest
2021-05-02 15:43:11 -04:00
needs: build
2021-05-01 17:24:18 -04:00
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 17:24:18 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
2021-05-01 17:24:18 -04:00
- name: Copy built site to production
run: |
mv ${{ github.workspace }}/_site /tmp/
mkdir -p /tmp/src
mv ${{ github.workspace }}/* /tmp/src/
mkdir -p ${{ github.workspace }}/src
mv /tmp/src/* ${{ github.workspace }}/src/
mv /tmp/_site ${{ github.workspace }}/
2021-05-01 23:59:01 -04:00
- name: Internal link checker
uses: untitaker/hyperlink@0.1.21
2021-05-01 17:24:18 -04:00
with:
args: _site/ --sources src/
2021-05-01 20:54:23 -04:00
extlink:
name: "Broken Hyperlinks (External)"
runs-on: ubuntu-latest
needs: [build, link]
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 23:59:01 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
2021-05-01 23:59:01 -04:00
- name: Cache HTMLProofer
id: cache-htmlproofer
uses: actions/cache@v3
2021-05-01 23:59:01 -04:00
with:
path: tmp/.htmlproofer
key: ${{ runner.os }}-htmlproofer-${{ hashFiles('_site/**.html') }}
restore-keys: |
${{ runner.os }}-htmlproofer-
${{ runner.os }}-htmlproofer
- name: Check External Links (Informational, Soft-Fail)
2021-05-01 23:18:10 -04:00
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
arguments: --assume-extension --external_only --internal-domains privacyguides.org,www.privacyguides.org --timeframe 30d --url-ignore '/https:\/\/developers\.cloudflare\.com\//,/https:\/\/github\.com\/privacyguides\/privacyguides\.org\/(edit|tree|blob)\/main/,/https:\/\/support\.(startmail|yubico)\.com\//'
2021-05-01 23:18:10 -04:00
continue-on-error: true
2021-05-01 20:54:23 -04:00
https:
2021-05-01 21:46:06 -04:00
name: "Require HTTPS Internal Images"
2021-05-01 20:54:23 -04:00
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 20:54:23 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
2021-05-01 23:59:01 -04:00
- name: Check Images
2021-05-01 20:54:23 -04:00
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
2021-05-01 21:46:06 -04:00
arguments: --assume-extension --check-img-http --internal-domains privacyguides.org,www.privacyguides.org --disable-external --checks-to-ignore LinkCheck,ScriptCheck
2021-05-01 20:54:23 -04:00
scripts:
name: "Script Reference Checks"
runs-on: ubuntu-latest
needs: [build, link]
2021-05-01 20:54:23 -04:00
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 20:54:23 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
2021-05-01 20:54:23 -04:00
- name: Check HTML
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
2021-05-01 21:46:06 -04:00
arguments: --assume-extension --check-html --disable-external --check-sri --report-script-embeds --internal-domains privacyguides.org,www.privacyguides.org --checks-to-ignore LinkCheck,ImageCheck,HtmlCheck
2021-05-01 20:54:23 -04:00
tags:
name: "HTML Tag Test"
runs-on: ubuntu-latest
needs: build
2021-05-01 20:54:23 -04:00
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 20:54:23 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
- name: Validate HTML
2021-05-01 20:54:23 -04:00
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
2021-05-01 21:46:06 -04:00
arguments: --assume-extension --check-html --disable-external --allow-hash-href --internal-domains privacyguides.org,www.privacyguides.org --report-invalid-tags --report-eof-tags --report-mismatched-tags --checks-to-ignore LinkCheck,ImageCheck,ScriptCheck
2021-05-01 20:54:23 -04:00
entity:
name: "HTML Entity Names Test"
runs-on: ubuntu-latest
needs: build
2021-05-01 20:54:23 -04:00
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 20:54:23 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
- name: Validate HTML
2021-05-01 20:54:23 -04:00
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
2021-05-01 21:46:06 -04:00
arguments: --assume-extension --check-html --disable-external --allow-hash-href --internal-domains privacyguides.org,www.privacyguides.org --report-missing-names --checks-to-ignore LinkCheck,ImageCheck,ScriptCheck
2021-05-01 20:54:23 -04:00
misc:
name: "Misc HTML Test"
runs-on: ubuntu-latest
needs: build
2021-05-01 20:54:23 -04:00
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 23:59:01 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
- name: Validate HTML
2021-05-01 20:54:23 -04:00
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
2021-05-01 21:46:06 -04:00
arguments: --assume-extension --check-html --disable-external --internal-domains privacyguides.org,www.privacyguides.org --report-missing-doctype --checks-to-ignore LinkCheck,ImageCheck,ScriptCheck
2021-05-01 20:54:23 -04:00
opengraph:
name: "OpenGraph Test"
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v3
2021-05-02 15:43:11 -04:00
- name: Download generated Jekyll site
uses: actions/download-artifact@v2
2021-05-01 23:59:01 -04:00
with:
2021-05-02 15:43:11 -04:00
name: generated-site
- run: tar xvf site.tar
- name: Check OpenGraph
2021-05-01 20:54:23 -04:00
uses: chabad360/htmlproofer@v1.1
with:
directory: ${{ github.workspace }}/_site
2021-05-01 21:46:06 -04:00
arguments: --assume-extension --disable-external --check-opengraph --checks-to-ignore LinkCheck,ImageCheck,ScriptCheck