Add standalone connector docs verification workflow#78
Merged
Conversation
ennyjfrick
approved these changes
May 18, 2026
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
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.
Why
The new connector docs process needs a required docs safety check on every standard connector repo, including repos that do not use the managed Verify workflow. Coupling that policy to Verify would either leave some repos out or silently add unrelated lint/test behavior.
What this changes
Adds a standalone reusable connector docs workflow that reports a stable
connector-docs / validatecheck. The workflow uses the pull request changed-files API to skip unchanged docs, validatesdocs/connector.mdxwhen it changes, and fails if the file was removed.The MDX validator now rejects unsafe constructs before compile: imports/exports, expression braces outside code, event-handler attributes, dangerous URL schemes, unsupported JSX tags, NUL/BOM, and malformed fences. The workflow installs pinned MDX tooling before checking out caller code, disables npm scripts, uses read-only permissions, and does not persist checkout credentials.
This keeps the existing Verify workflow compatibility path intact, only adding
Checkto its component allowlist. The standalone workflow should be released before baton-admin adds caller workflows, and the required status check should only be enabled after connector PRs showconnector-docs / validateon both docs and non-doc changes.Validation
git diff --checkyqnode --check tools/mdx-lint/mdx-lint.mjs