justinpakzad opened a new pull request, #65073:
URL: https://github.com/apache/airflow/pull/65073
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
http://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the
documentation.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
---
This PR attempts to implement a YAML based approach to map airflow-ctl help
texts. The idea behind this was to have a single source of truth that can be
easy to validate in the pre-commit (see the linked issue for a bit more
detail). This targets the auto-generated commands. I also created a prek hook
`check_airflowctl_help_texts` that ensures all the auto-generated commands have
their respective help texts.
A couple of notes on the approach:
I created a `help_texts.yaml` file in the ctl directory with all the
group/subcommand to help text mappings. Not sure if there is a specific naming
convention we would like to follow so happy to change that if needed. Inside
the `CommandFactory()` class we read the help_texts into an instance variable
and then use it to look up and assign the help text in the
`_create_group_commands_from_operation()` method. Added an additional test case
that tests the help texts from YAML are used for auto-generated commands.
I moved the `parse_operations()` function into the common prek utils so that
it can be used in the new hook & the airflowctl command coverage (which is
where it was originally) without duplicating code. The check goes through the
auto-generated commands, performs a look up against the yaml, collects any that
are missing, and then will output a message describing which are missing and
the file they should be added to.
Curious to hear if this approach makes sense and open to any suggestions.
related: #57632
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [x] Yes (Claude Sonnet 4.6 for generating the yaml with the help texts)
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
