Skip draft pages in Lighthouse CI#206
Open
kcmartin wants to merge 1 commit into
Open
Conversation
Contributor
Preview Deployment
Commit: |
Contributor
Lighthouse Results
|
Contributor
E2E Test Results✅ Tests success Ran against: https://pr-206-superfly-sprites-docs.fly.dev |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The Lighthouse job builds its URL list from every
.mdxa PR changes, without checking whether the page is a draft. Draft pages (draft: true) are excluded from the production build, so their URLs 404 on the preview deploy and Lighthouse fails the run withERRORED_DOCUMENT_REQUEST (Status code: 404).This bit PR #205, which edited the draft
reference/configuration.mdxand failed Lighthouse on/reference/configuration/even though the change was fine.Fix
In the "Get changed pages" step, read each changed file's frontmatter (the PR head is already checked out) and skip any page with
draft: truebefore adding its URL. Unreadable files fall through and are still tested, so nothing is silently dropped.Verified locally:
draft: truepages are skipped, published pages are still tested, and the workflow YAML still parses.