Run tooltip validation on every PR so the required check can't get stuck#703
Open
danstotts-ops wants to merge 1 commit into
Open
Run tooltip validation on every PR so the required check can't get stuck#703danstotts-ops wants to merge 1 commit into
danstotts-ops wants to merge 1 commit into
Conversation
"Check tooltip imports" is a required status check, but the workflow was path-filtered to .mdx/tooltip files. PRs touching none of those paths (e.g. docs.json-only redirect PRs like #694) never trigger the workflow, so the required check sits in "expected" forever and the merge is blocked. Remove the paths filter so the workflow always runs. The validate script scans all tracked .mdx files in ~0.1s and exits 0 when nothing is broken, so unconditional runs are effectively free. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
Branch protection on
mainrequires the status check Check tooltip imports, produced by.github/workflows/validate-tooltips.yml. That workflow was path-filtered to**.mdx,snippets/tooltips.jsx,scripts/validate-tooltips.js, and the workflow file itself.GitHub required checks have no concept of "skipped by paths filter": if the workflow never triggers, the check stays in expected state forever and the PR is unmergeable. Any PR touching none of the filtered paths hits this, most commonly
docs.json-only changes. Concrete example: #694 (redirects-only) is currently blocked by exactly this.Fix
Remove the
paths:filter so the workflow runs on every PR tomain, per GitHub's recommended handling for required checks (always run the workflow; let it no-op fast when there's nothing to check). A comment in the workflow now warns against re-adding a filter.Why this is safe and cheap
scripts/validate-tooltips.jsscans all tracked.mdxfiles on every run regardless of the diff. Verified locally on a clean checkout:0in ~0.13s (295 MDX files, 49 tooltip definitions)So on an unrelated PR (e.g.
docs.json-only), the job checks out, runs in well under a minute, and reports success, unblocking JSON-only PRs while keeping identical validation for MDX changes.🤖 Generated with Claude Code