Skip to content

Update docs for Airflow CLI help command#51042

Merged
potiuk merged 7 commits intoapache:mainfrom
rapsealk:docs/update-docker-entrypoint-cli-help-message
Jul 15, 2025
Merged

Update docs for Airflow CLI help command#51042
potiuk merged 7 commits intoapache:mainfrom
rapsealk:docs/update-docker-entrypoint-cli-help-message

Conversation

@rapsealk
Copy link
Contributor

@rapsealk rapsealk commented May 25, 2025 •
edited
Loading

Hello Airflow!

While following the official documents, I found that the help message in CLI has been changed.

This pull request updates the help message based on apache/airflow:3.0.1-python3.12 running in standalone mode.

Thanks for your review in advance!

Refs

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@boring-cyborg boring-cyborg bot added area:production-image Production image improvements and fixes kind:documentation labels May 25, 2025
@boring-cyborg
Copy link

boring-cyborg bot commented May 25, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@rapsealk
Copy link
Contributor Author

rapsealk commented May 25, 2025

I might have missed some executors?

airflow/providers/fab/src/airflow/providers/fab/auth_manager/fab_auth_manager.py

Lines 186 to 207 in 84769be

@staticmethod
def get_cli_commands() -> list[CLICommand]:
"""Vends CLI commands to be included in Airflow CLI."""
commands: list[CLICommand] = [
GroupCommand(
name="users",
help="Manage users",
subcommands=USERS_COMMANDS,
),
GroupCommand(
name="roles",
help="Manage roles",
subcommands=ROLES_COMMANDS,
),
SYNC_PERM_COMMAND, # not in a command group
]
# If Airflow version is 3.0.0 or higher, add the fab-db command group
if packaging.version.parse(
packaging.version.parse(airflow_version).base_version
) >= packaging.version.parse("3.0.0"):
commands.append(GroupCommand(name="fab-db", help="Manage FAB", subcommands=DB_COMMANDS))
return commands

airflow/airflow-core/src/airflow/cli/cli_parser.py

Lines 63 to 86 in 84769be

for executor_name in ExecutorLoader.get_executor_names():
try:
executor, _ = ExecutorLoader.import_executor_cls(executor_name)
airflow_commands.extend(executor.get_cli_commands())
except Exception:
log.exception("Failed to load CLI commands from executor: %s", executor_name)
log.error(
"Ensure all dependencies are met and try again. If using a Celery based executor install "
"a 3.3.0+ version of the Celery provider. If using a Kubernetes executor, install a "
"7.4.0+ version of the CNCF provider"
)
# Do not re-raise the exception since we want the CLI to still function for
# other commands.
try:
auth_mgr = get_auth_manager_cls()
airflow_commands.extend(auth_mgr.get_cli_commands())
except Exception as e:
log.warning("cannot load CLI commands from auth manager: %s", e)
log.warning("Auth manager is not configured and api-server will not be able to start.")
# do not re-raise for the same reason as above
if len(sys.argv) > 1 and sys.argv[1] == "api-server":
log.exception(e)
sys.exit(1)

@github-actions
Copy link

github-actions bot commented Jul 12, 2025

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Jul 12, 2025
@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Jul 13, 2025
@potiuk potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Jul 15, 2025
@potiuk potiuk merged commit ea5dbcf into apache:main Jul 15, 2025
54 checks passed
github-actions bot pushed a commit that referenced this pull request Jul 15, 2025
@rapsealk
[v3-0-test] Update docs for Airflow CLI help command (#51042)
5d158e0 
(cherry picked from commit ea5dbcf)

Co-authored-by: Jeongseok Kang <[email protected]>
@github-actions
Copy link

github-actions bot commented Jul 15, 2025

Backport successfully created: v3-0-test

Status Branch Result
✅ v3-0-test PR Link

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Jul 15, 2025
@rapsealk
[v3-0-test] Update docs for Airflow CLI help command (apache#51042)
ba06023 
(cherry picked from commit ea5dbcf)

Co-authored-by: Jeongseok Kang <[email protected]>
github-actions bot pushed a commit to guan404ming/airflow that referenced this pull request Jul 15, 2025
@rapsealk
[v3-0-test] Update docs for Airflow CLI help command (apache#51042)
14ded6f 
(cherry picked from commit ea5dbcf)

Co-authored-by: Jeongseok Kang <[email protected]>
@rapsealk rapsealk deleted the docs/update-docker-entrypoint-cli-help-message branch July 16, 2025 13:14
eladkal pushed a commit that referenced this pull request Aug 2, 2025
@github-actions @rapsealk
[v3-0-test] Update docs for Airflow CLI help command (#51042) (#53383)
d3547e6 
(cherry picked from commit ea5dbcf)

Co-authored-by: Jeongseok Kang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@potiuk potiuk potiuk approved these changes

Assignees

No one assigned

Labels

area:production-image Production image improvements and fixes backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rapsealk @potiuk