Documentation
¶
Overview ¶
pagescheck asks whether a GitHub Pages site serves what its repository builds.
pagescheck -orgs go-ooxml,go-richdoc pagescheck -fail-on-drift
⛔ A GREEN DEPLOY IS NOT A SERVED PAGE. go-ooxml.github.io served the default Jekyll theme's rendering of README.md -- 5 512 bytes of it -- while its deploy-pages workflow built the Hugo site, uploaded the artefact and reported success three times. Nothing was broken: the build was correct, the upload was correct, and the setting that decides which of the two is published lives in the API rather than in any file, so no file was wrong and no check looked at the URL.
That is why this reads the PAGE and not the repository. A workflow can only say what it did; the URL says what a reader gets.
⛔ The source of the failure is `build_type`. "workflow" publishes the artefact a workflow uploaded; "legacy" builds the branch with Jekyll and throws the artefact away. A repository with a deploy workflow and a legacy build type is the defect, and it is invisible from the repository's files.
Source Files