Validate documented commands against the Breeze and prek registries#70186
Merged
Conversation
RoyLee1224
requested review from
amoghrajesh,
ashb,
bugraoz93,
gopidesupavan,
jason810496,
jscheffl and
potiuk
as code owners
July 21, 2026 12:05
potiuk
approved these changes
Jul 21, 2026
potiuk
left a comment
Member
There was a problem hiding this comment.
Nice, deterministic check. Agents miss thing sometimes so indeed deterministic harness around it is a good idea.
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.
cc @potiuk @bugraoz93 you've got the most context on these changes, mind a quick sanity check before this merges? Want to make sure I'm reading them right.
Why
AGENTS.mdused to documentbreeze selective-checks, which was never a real command (it'sbreeze ci selective-check), until #69861 fixed it by hand.contributing-docs/is all hand(agent)-written, so this kind of thing rots quietly.These are the docs agents read to run commands and increasingly edit themselves, so validating them against the real registry makes agent-assisted doc changes more reliable, wrong commands get caught at commit time instead of propagating.
What
A prek hook pulls every
`breeze …`and`prek run …`out ofAGENTS.mdandcontributing-docs/and checks them against the real registries:--options).pre-commit-config.yamlfilesIt catches both a command that's simply wrong in the docs, and one that got renamed without the docs following — the hook re-runs when
commands/**changes, so a rename that touches no docs still fails. Passthrough commands,<placeholder>args and--helpare skipped so it doesn't flag things that are fine, and errors include a "did you mean" suggestion. It only runs when docs, breeze commands or prek configs change, not on every PR.Evidence
Running it over the current tree turned up 10 stale/mistyped commands in
contributing-docs/— 7 distinct ones, wrong for 6 to 20 months. One (#43979) deleted theintegration-testssubcommand and in the same commit added a docline pointing at it. All fixed here.
03_contributors_quick_start.rstbreeze setup config --terminal_multiplexer--terminal-multiplexertesting/task_sdk_integration_tests.rstbreeze prod image buildbreeze prod-image buildtesting/integration_tests.rstbreeze providers-integration-tests --helpbreeze testing providers-integration-teststesting/integration_tests.rstbreeze core-integration-tests --helpbreeze testing core-integration-teststesting/unit_tests.rstbreeze testing integration-testsbreeze testing core-integration-tests/providers-integration-tests27_cli_implementation_guide.rstbreeze testing airflow-ctl-integration-testbreeze testing airflow-ctl-integration-teststesting/airflow_ctl_tests.rstbreeze testing airflow-ctl-integration-testbreeze testing airflow-ctl-integration-testsWas generative AI tooling used to co-author this PR?
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.