docs: add provider guide standard and drift check#635
Open
caiopizzol wants to merge 2 commits into
Open
Conversation
Adds --changed-from/--changed-to so the workflow passes two SHAs instead of hand-building repeated --changed flags in bash. The CLI runs the git diff and fails closed if it cannot, so a shallow checkout no longer silently passes the gate. The existing --changed interface is unchanged.
laurenzlong
approved these changes
Jun 25, 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
2 participants
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.
Adds a written standard for provider guides and a CI check that keeps a changed guide consistent with the connector catalog. Guides drift over time (action claims the catalog doesn't support, sample links that 404), and there's been no single place that says how to write one.
PROVIDER_GUIDE.md: the canonical standard. How a guide filename maps to a catalog key, the exact action-link format the drift check looks for, and the deep-connector and sample rules. Links toCONTRIBUTING.mdfor shared style instead of repeating it.AGENTS.md/CLAUDE.md: short pointers so agents read the standard and run the drift check before finishing..github/workflows/provider-guide-drift.yml: runs the drift check in per-PR mode on changed guides, failing only on real errors in those guides (overclaimed actions, a slug that resolves to no catalog entry, dead sample links). It does not gate on the existing undocumented-provider backlog, so unrelated PRs aren't blocked.README: points contributors to the standard.