Pipeline test

This page shows the live result of the Doc Detective test that verifies the pipeline overview page. The test runs daily and on every push to main, and it fails if the page stops loading or stops mentioning any of the five pipeline tools.

Why this matters​

The test checks a claim: that the pipeline page still names Vale, codespell, Lychee, Doc Detective, and docmeta. If a tool gets swapped out, the page gets rewritten, or the page goes down, then the claim no longer holds and the test fails automatically. It does this on a schedule, without anyone having to remember to reread the page and check.

This is analogous to making sure a page stays in sync with requirements.

The status badge makes the results immediately visible. Most continuous integration (CI) results live inside GitHub Actions, so they are invisible unless someone goes looking. Surfacing the result on the page it tests makes the verification part of the documentation itself.

Latest result​

How the test works​

The test is defined in doc-detective/tests/sample.json and runs the following steps:

1. Navigate to the pipeline overview page.
2. Find the h1 heading and confirm it reads "Documentation Pipeline Portfolio".
3. Confirm the page body mentions Vale, codespell, Lychee, and Doc Detective.

If the page is renamed, restructured, or stops mentioning one of the tools, this test fails and the badge turns red.

Run the test manually​

If you clone this repo, then you can run the test locally.

npm install -g doc-detective
cd website && npm run build && npx docusaurus serve --no-open &
doc-detective --config doc-detective/config.json --input doc-detective/tests/sample.json

Run the test on GitHub Actions​

The test runs automatically every day at 10:00 UTC (3:00 AM Pacific) and on every push to main that touches website/docs/ or doc-detective/tests/. To trigger it on demand:

1. Go to the Actions tab in the GitHub repository.
2. Select Pipeline page test.
3. Click Run workflow.