CI: verify docs resources #235
Conversation
Check the docs app to ensure all the links and assets resolve correctly. The docs app runs in SSR mode to ensure the fully rendered page contents can be tested.
Improve the script run by `jq` to simplify the test, remove the need for the `tee` command and the `.missing-links` local cache file.
Check the docs app preview deployed to Netlify, to ensure all the links and assets resolve correctly.
RobinKnipe
force-pushed
the
ci/verify-docs-resources
branch
from
364f14c to
84d3f98
Compare
| @@ -0,0 +1,28 @@ | |||
| #!/bin/bash +x | |||
There was a problem hiding this comment.
Do we still need the +x?
There was a problem hiding this comment.
Is it better to do #! /bin/env bash these days?
There was a problem hiding this comment.
Good question! Not really a short answer, but I think it boils down to using /bin/env is more portable but slightly less secure. I don't think either is a strong enough consideration to influence this context though.
| @@ -0,0 +1,28 @@ | |||
| #!/bin/bash +x | |||
|
|
|||
| set -e | |||
There was a problem hiding this comment.
Oh maybe not, you disable this later.
There was a problem hiding this comment.
Yes, there's more than one thing running here, so the exit code needs to be set after clean-up, and reflect the outcome of the test process.
|
|
||
| [ -d node_modules ] && [ -f dist/server/index.js ] || make deps build > /dev/null | ||
| set +e | ||
| npm run ssr > /dev/null & |
There was a problem hiding this comment.
dev:ssr?
Or even SSR_ONLY=true npm start?
There was a problem hiding this comment.
Oh I see, you added a script for this.
| @@ -6,12 +6,13 @@ | |||
| "main": "dist/server/index.js", | |||
| "scripts": { | |||
| "start": "node .", | |||
| "test": "echo \"Error: no test specified\" && exit 1", | |||
| "test": "exec ./check-links.sh", | |||
|
I agree with this in principle. I really want something like this. I think it should be solved more generally though. i.e. All new apps should get this sort of basic acceptance testing out of the box. I've been thinking of this as a subset of the functional tests (that don't yet exist!) so I was thinking of having something that runs inside of cypress. |
Check the docs app to ensure all the links and assets resolve correctly.
There is a local check that brings up the docs in SSR mode and works with the usual runners:
npm testmake testExtra steps have also been added to the
deploy-docsGitHub action workflow to check the generated Netlify preview.