This is an automated email from the ASF dual-hosted git repository.
eladkal 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 413698ed1d Use correct prefixes for distribution packages in provider
documentation (#39341)
413698ed1d is described below
commit 413698ed1d4388e87e1bbded05956799edd3fc39
Author: Andrey Anshin <[email protected]>
AuthorDate: Wed May 1 18:55:28 2024 +0400
Use correct prefixes for distribution packages in provider documentation
(#39341)
---
.../templates/PROVIDER_INDEX_TEMPLATE.rst.jinja2 | 4 ++--
dev/breeze/src/airflow_breeze/utils/packages.py | 4 ++--
dev/breeze/tests/test_packages.py | 10 +++++-----
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git
a/dev/breeze/src/airflow_breeze/templates/PROVIDER_INDEX_TEMPLATE.rst.jinja2
b/dev/breeze/src/airflow_breeze/templates/PROVIDER_INDEX_TEMPLATE.rst.jinja2
index aa48522e1c..cbc8255fd2 100644
--- a/dev/breeze/src/airflow_breeze/templates/PROVIDER_INDEX_TEMPLATE.rst.jinja2
+++ b/dev/breeze/src/airflow_breeze/templates/PROVIDER_INDEX_TEMPLATE.rst.jinja2
@@ -94,8 +94,8 @@ Downloading official packages
You can download officially released packages and verify their checksums and
signatures from the
`Official Apache Download site
<https://downloads.apache.org/airflow/providers/>`_
-* `The {{ PACKAGE_PIP_NAME }} {{ RELEASE }}{{ VERSION_SUFFIX }} sdist package
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_PIP_NAME }}-{{
RELEASE }}{{ VERSION_SUFFIX }}.tar.gz>`_ (`asc
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_PIP_NAME }}-{{
RELEASE }}{{ VERSION_SUFFIX }}.tar.gz.asc>`__, `sha512
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_PIP_NAME }}-{{
RELEASE }}{{ VERSION_SUFFIX }}.tar.gz.sha512>`__)
-* `The {{ PACKAGE_PIP_NAME }} {{ RELEASE }}{{ VERSION_SUFFIX }} wheel package
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_WHEEL_NAME }}-{{
RELEASE }}{{ VERSION_SUFFIX }}-py3-none-any.whl>`_ (`asc
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_WHEEL_NAME }}-{{
RELEASE }}{{ VERSION_SUFFIX }}-py3-none-any.whl.asc>`__, `sha512
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_WHEEL_NAME }}-{{
RELEASE }}{{ VERSION_SUFFIX }}-py3-none-any.whl.sha512>`__)
+* `The {{ PACKAGE_PIP_NAME }} {{ RELEASE }}{{ VERSION_SUFFIX }} sdist package
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_DIST_PREFIX }}-{{
RELEASE }}{{ VERSION_SUFFIX }}.tar.gz>`_ (`asc
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_DIST_PREFIX }}-{{
RELEASE }}{{ VERSION_SUFFIX }}.tar.gz.asc>`__, `sha512
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_DIST_PREFIX }}-{{
RELEASE }}{{ VERSION_SUFFIX }}.tar.gz.sha512>`__)
+* `The {{ PACKAGE_PIP_NAME }} {{ RELEASE }}{{ VERSION_SUFFIX }} wheel package
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_DIST_PREFIX }}-{{
RELEASE }}{{ VERSION_SUFFIX }}-py3-none-any.whl>`_ (`asc
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_DIST_PREFIX }}-{{
RELEASE }}{{ VERSION_SUFFIX }}-py3-none-any.whl.asc>`__, `sha512
<https://downloads.apache.org/airflow/providers/{{ PACKAGE_DIST_PREFIX }}-{{
RELEASE }}{{ VERSION_SUFFIX }}-py3-none-any.whl.sha512>`__)
diff --git a/dev/breeze/src/airflow_breeze/utils/packages.py
b/dev/breeze/src/airflow_breeze/utils/packages.py
index 048d05046d..5f4d1070d3 100644
--- a/dev/breeze/src/airflow_breeze/utils/packages.py
+++ b/dev/breeze/src/airflow_breeze/utils/packages.py
@@ -398,7 +398,7 @@ def get_pip_package_name(provider_id: str) -> str:
return "apache-airflow-providers-" + provider_id.replace(".", "-")
-def get_wheel_package_name(provider_id: str) -> str:
+def get_dist_package_name_prefix(provider_id: str) -> str:
"""
Returns Wheel package name prefix for the package id.
@@ -585,7 +585,7 @@ def get_provider_jinja_context(
context: dict[str, Any] = {
"PROVIDER_ID": provider_details.provider_id,
"PACKAGE_PIP_NAME": get_pip_package_name(provider_details.provider_id),
- "PACKAGE_WHEEL_NAME":
get_wheel_package_name(provider_details.provider_id),
+ "PACKAGE_DIST_PREFIX":
get_dist_package_name_prefix(provider_details.provider_id),
"FULL_PACKAGE_NAME": provider_details.full_package_name,
"RELEASE": current_release_version,
"RELEASE_NO_LEADING_ZEROS": release_version_no_leading_zeros,
diff --git a/dev/breeze/tests/test_packages.py
b/dev/breeze/tests/test_packages.py
index 34ea47596c..9d0fd23717 100644
--- a/dev/breeze/tests/test_packages.py
+++ b/dev/breeze/tests/test_packages.py
@@ -29,6 +29,7 @@ from airflow_breeze.utils.packages import (
find_matching_long_package_names,
get_available_packages,
get_cross_provider_dependent_packages,
+ get_dist_package_name_prefix,
get_documentation_package_path,
get_install_requirements,
get_long_package_name,
@@ -44,7 +45,6 @@ from airflow_breeze.utils.packages import (
get_source_package_path,
get_suspended_provider_folders,
get_suspended_provider_ids,
- get_wheel_package_name,
validate_provider_info_with_runtime_schema,
)
from airflow_breeze.utils.path_utils import AIRFLOW_PROVIDERS_ROOT,
AIRFLOW_SOURCES_ROOT, DOCS_ROOT
@@ -336,14 +336,14 @@ def test_get_pip_package_name(provider_id: str,
pip_package_name: str):
@pytest.mark.parametrize(
- "provider_id, wheel_package_name",
+ "provider_id, expected_package_name",
[
("asana", "apache_airflow_providers_asana"),
("apache.hdfs", "apache_airflow_providers_apache_hdfs"),
],
)
-def test_get_wheel_package_name(provider_id: str, wheel_package_name: str):
- assert get_wheel_package_name(provider_id) == wheel_package_name
+def test_get_dist_package_name_prefix(provider_id: str, expected_package_name:
str):
+ assert get_dist_package_name_prefix(provider_id) == expected_package_name
@pytest.mark.parametrize(
@@ -481,7 +481,7 @@ def test_provider_jinja_context():
expected = {
"PROVIDER_ID": "amazon",
"PACKAGE_PIP_NAME": "apache-airflow-providers-amazon",
- "PACKAGE_WHEEL_NAME": "apache_airflow_providers_amazon",
+ "PACKAGE_DIST_PREFIX": "apache_airflow_providers_amazon",
"FULL_PACKAGE_NAME": "airflow.providers.amazon",
"RELEASE": version,
"RELEASE_NO_LEADING_ZEROS": version,
