This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 927e8b799a Establishing short hand argument for
apache-airflow-providers rule (#34230)
927e8b799a is described below
commit 927e8b799a2255ffecb1eaeda4ad0e55675fa4bf
Author: Amogh Desai <[email protected]>
AuthorDate: Sat Sep 9 23:39:17 2023 +0530
Establishing short hand argument for apache-airflow-providers rule (#34230)
* Establishing short hand argument for apache-airflow-providers rule
* updating docs
* review comments
---
BREEZE.rst | 2 ++
dev/breeze/src/airflow_breeze/commands/developer_commands.py | 4 ++--
dev/breeze/src/airflow_breeze/params/doc_build_params.py | 5 ++++-
dev/breeze/src/airflow_breeze/utils/common_options.py | 10 ++++++++++
docs/README.rst | 2 ++
images/breeze/output-commands-hash.txt | 2 +-
images/breeze/output_build-docs.svg | 2 +-
7 files changed, 22 insertions(+), 5 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 148cda18c2..f791ee73a5 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -492,6 +492,8 @@ Now with the remaining part, replace every ``dash("-")``
with a ``dot(".")``.
Example:
If the provider name is ``apache-airflow-providers-cncf-kubernetes``, it will
be ``cncf.kubernetes``.
+Note: For building docs for apache-airflow-providers index, use
``providers-index`` as the short hand operator.
+
Running static checks
---------------------
diff --git a/dev/breeze/src/airflow_breeze/commands/developer_commands.py
b/dev/breeze/src/airflow_breeze/commands/developer_commands.py
index fded9415c0..21f2852951 100644
--- a/dev/breeze/src/airflow_breeze/commands/developer_commands.py
+++ b/dev/breeze/src/airflow_breeze/commands/developer_commands.py
@@ -42,7 +42,7 @@ from airflow_breeze.pre_commit_ids import PRE_COMMIT_LIST
from airflow_breeze.utils.cache import read_from_cache_file
from airflow_breeze.utils.coertions import one_or_none_set
from airflow_breeze.utils.common_options import (
- argument_packages_plus_all_providers,
+ argument_packages_plus_all_providers_for_shorthand,
option_airflow_constraints_reference,
option_airflow_extras,
option_answer,
@@ -357,7 +357,7 @@ def start_airflow(
@main.command(name="build-docs")
@click.option("-d", "--docs-only", help="Only build documentation.",
is_flag=True)
@click.option("-s", "--spellcheck-only", help="Only run spell checking.",
is_flag=True)
-@argument_packages_plus_all_providers
+@argument_packages_plus_all_providers_for_shorthand
@option_builder
@click.option(
"--package-filter",
diff --git a/dev/breeze/src/airflow_breeze/params/doc_build_params.py
b/dev/breeze/src/airflow_breeze/params/doc_build_params.py
index 70dfb97b3a..bd02ae7903 100644
--- a/dev/breeze/src/airflow_breeze/params/doc_build_params.py
+++ b/dev/breeze/src/airflow_breeze/params/doc_build_params.py
@@ -27,8 +27,11 @@ providers_prefix = "apache-airflow-providers-"
def get_provider_name_from_short_hand(short_form_providers: tuple[str]):
providers = []
for short_form_provider in short_form_providers:
- short_form_provider.split(".")
+ if short_form_provider == "providers-index":
+ providers.append("apache-airflow-providers")
+ continue
+ short_form_provider.split(".")
parts = "-".join(short_form_provider.split("."))
providers.append(providers_prefix + parts)
return tuple(providers)
diff --git a/dev/breeze/src/airflow_breeze/utils/common_options.py
b/dev/breeze/src/airflow_breeze/utils/common_options.py
index 47bf42530a..95a0b46ebe 100644
--- a/dev/breeze/src/airflow_breeze/utils/common_options.py
+++ b/dev/breeze/src/airflow_breeze/utils/common_options.py
@@ -450,6 +450,16 @@ argument_packages_plus_all_providers = click.argument(
required=False,
type=BetterChoice(["all-providers"] +
get_available_documentation_packages(short_version=True)),
)
+
+argument_packages_plus_all_providers_for_shorthand = click.argument(
+ "packages_plus_all_providers",
+ nargs=-1,
+ required=False,
+ type=BetterChoice(
+ ["all-providers"] +
get_available_documentation_packages(short_version=True) + ["providers-index"]
+ ),
+)
+
option_airflow_constraints_reference = click.option(
"--airflow-constraints-reference",
help="Constraint reference to use. Useful with --use-airflow-version
parameter to specify "
diff --git a/docs/README.rst b/docs/README.rst
index fb1e4e5f6d..d30fa6132b 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -100,6 +100,8 @@ Now with the remaining part, replace every ``dash("-")``
with a ``dot(".")``.
Example:
If the provider name is ``apache-airflow-providers-cncf-kubernetes``, it will
be ``cncf.kubernetes``.
+Note: For building docs for apache-airflow-providers index, use
``providers-index`` as the short hand operator.
+
Cross-referencing syntax
========================
diff --git a/images/breeze/output-commands-hash.txt
b/images/breeze/output-commands-hash.txt
index 84a251b123..2d7b5ee100 100644
--- a/images/breeze/output-commands-hash.txt
+++ b/images/breeze/output-commands-hash.txt
@@ -2,7 +2,7 @@
# Please do not solve it but run `breeze setup regenerate-command-images`.
# This command should fix the conflict and regenerate help images that you
have conflict with.
main:42493af4045e28dcf52040810fbb7036
-build-docs:68f124750a9b83d45e10dec7219b6014
+build-docs:c5da2956cfff3989a9699c32aee63a13
ci:find-backtracking-candidates:17fe56b867a745e5032a08dfcd3f73ee
ci:fix-ownership:3e5a73533cc96045e72cb258783cfc96
ci:free-space:49af17b032039c05c41a7a8283f365cc
diff --git a/images/breeze/output_build-docs.svg
b/images/breeze/output_build-docs.svg
index 273f849801..96a78ce202 100644
--- a/images/breeze/output_build-docs.svg
+++ b/images/breeze/output_build-docs.svg
@@ -168,7 +168,7 @@
</text><text class="breeze-build-docs-r1" x="12.2" y="239.6"
textLength="1354.2"
clip-path="url(#breeze-build-docs-line-9)">                         | odbc | openfaas | openlineage | opsgenie | oracle | pagerduty | papermill | plexus |</text><text
class="breeze-build-docs-r2" x="1464" y [...]
</text><text class="breeze-build-docs-r1" x="12.2" y="264" textLength="1403"
clip-path="url(#breeze-build-docs-line-10)">                         postgres | presto | redis | salesforce | samba | segment | sendgrid | sftp | singularity |</text><text
class="breeze-build-docs-r2" x="1 [...]
</text><text class="breeze-build-docs-r1" x="12.2" y="288.4" textLength="1403"
clip-path="url(#breeze-build-docs-line-11)">                         slack | smtp | snowflake | sqlite | ssh | tableau | tabular | telegram | trino | vertica |</text><text
class="breeze-build-d [...]
-</text><text class="breeze-build-docs-r1" x="12.2" y="312.8" textLength="549"
clip-path="url(#breeze-build-docs-line-12)">                         yandex | zendesk]...</text><text
class="breeze-build-docs-r2" x="1464" y="312.8" textLength="12.2"
clip-path="url(#breeze-build-docs-line-12)">
+</text><text class="breeze-build-docs-r1" x="12.2" y="312.8"
textLength="768.6"
clip-path="url(#breeze-build-docs-line-12)">                         yandex | zendesk | providers-index]...</text><text
class="breeze-build-docs-r2" x="1464" y="312.8" textLength="12.2"
clip-path="url(#breeze-build-docs-line-12)">
</text><text class="breeze-build-docs-r2" x="1464" y="337.2" textLength="12.2"
clip-path="url(#breeze-build-docs-line-13)">
</text><text class="breeze-build-docs-r2" x="12.2" y="361.6"
textLength="195.2"
clip-path="url(#breeze-build-docs-line-14)">Build documents.</text><text
class="breeze-build-docs-r2" x="1464" y="361.6" textLength="12.2"
clip-path="url(#breeze-build-docs-line-14)">
</text><text class="breeze-build-docs-r2" x="1464" y="386" textLength="12.2"
clip-path="url(#breeze-build-docs-line-15)">
