Skip to content

Incorrect Breeze selective checks command in contributor documentation #69858

Description

@viiccwen

Under which category would you file this issue?

Airflow Core

Apache Airflow version

main

What happened and how to reproduce it?

Contributor documentation instructs developers and coding agents to determine the required test scope with:

breeze selective-checks --commit-ref <commit_sha>

The command is documented in the generated Commands section of AGENTS.md and in the selective checks troubleshooting guide. Running it from the repository root fails because selective-checks is not a top-level Breeze command:

$ breeze selective-checks --help
Error: No such command 'selective-checks'.

Adding the documented concept as a ci subcommand while retaining the plural form also fails:

$ breeze ci selective-checks --help
Error: No such command 'selective-checks'. (Did you mean one of: 'resource-check', 'selective-check'?)

The registered command, shown by breeze ci --help and used by the GitHub Actions workflows, is:

breeze ci selective-check --commit-ref <commit_sha>

The incorrect generated AGENTS.md entry originates in the AGENT-SKILL block in contributing-docs/08_static_code_checks.rst. The generator test currently expects the same incorrect command, so it does not detect the mismatch.

What you think should happen instead?

Contributor documentation should consistently use the registered command:

breeze ci selective-check --commit-ref <commit_sha>

The source AGENT-SKILL block, generated AGENTS.md content, selective checks troubleshooting guide, and generator test should be updated together so the documented local reproduction command matches the CLI and CI workflows.

Operating System

No response

Deployment

None

Apache Airflow Provider(s)

No response

Versions of Apache Airflow Providers

No response

Official Helm Chart version

Not Applicable

Kubernetes Version

No response

Helm Chart configuration

No response

Docker Image customizations

No response

Anything else?

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:dev-envCI, pre-commit, pylint and other changes that do not change the behavior of the final codekind:bugThis is a clearly a bugkind:documentationneeds-triagelabel for new issues that we didn't triage yet

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions