From ad7f02ad4ac0652ba3c4cbee6adea186b6918409 Mon Sep 17 00:00:00 2001 From: Amogh Date: Mon, 17 Jul 2023 17:16:15 +0530 Subject: [PATCH 1/5] Fixing breeze add-back-references command with doc --- dev/README_RELEASE_AIRFLOW.md | 3 ++- dev/README_RELEASE_HELM_CHART.md | 4 ++-- dev/README_RELEASE_PROVIDER_PACKAGES.md | 4 ++-- .../commands/release_management_commands.py | 1 - images/breeze/output-commands-hash.txt | 4 ++-- ...ut_release-management_add-back-references.svg | 16 ++++++++-------- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/dev/README_RELEASE_AIRFLOW.md b/dev/README_RELEASE_AIRFLOW.md index 08ec16a68bfdd..db4ecb23a4748 100644 --- a/dev/README_RELEASE_AIRFLOW.md +++ b/dev/README_RELEASE_AIRFLOW.md @@ -802,10 +802,11 @@ Documentation for providers can be found in the ``/docs/apache-airflow`` directo ``` - Copy the documentation to the ``airflow-site`` repository, create commit, push changes, open a PR and merge it when the build is green. +- Either provide the ``--airflow-site-directory`` flag or set the env variable: ``AIRFLOW_SITE_DIRECTORY`` ```shell script breeze release-management publish-docs --package-filter apache-airflow --package-filter docker-stack - breeze release-management add-back-references --airflow-site-directory --gen-type airflow + breeze release-management add-back-references --airflow-site-directory DIRECTORY --gen-type airflow git add . git commit -m "Add documentation for Apache Airflow ${VERSION}" git push diff --git a/dev/README_RELEASE_HELM_CHART.md b/dev/README_RELEASE_HELM_CHART.md index 087c56b3f83d3..de41cc9472072 100644 --- a/dev/README_RELEASE_HELM_CHART.md +++ b/dev/README_RELEASE_HELM_CHART.md @@ -631,10 +631,10 @@ between the two repositories to be able to build the documentation. - Update `index.yaml` Regenerate `index.yaml` so it can be added to the Airflow website to allow: `helm repo add https://airflow.apache.org`. + Note: Either provide the ``--airflow-site-directory`` flag or set the env variable: ``AIRFLOW_SITE_DIRECTORY`` ```shell - cd "${AIRFLOW_SITE_DIRECTORY}" - breeze release-management add-back-references --airflow-site-directory --gen-type helm + breeze release-management add-back-references --airflow-site-directory DIRECTORY --gen-type helm cd .. curl https://dist.apache.org/repos/dist/dev/airflow/helm-chart/$RC/index.yaml -o index.yaml cp ${AIRFLOW_SVN_RELEASE_HELM}/${VERSION}/airflow-${VERSION}.tgz . diff --git a/dev/README_RELEASE_PROVIDER_PACKAGES.md b/dev/README_RELEASE_PROVIDER_PACKAGES.md index 323a83a9666ce..e7f9d3c742bfd 100644 --- a/dev/README_RELEASE_PROVIDER_PACKAGES.md +++ b/dev/README_RELEASE_PROVIDER_PACKAGES.md @@ -381,6 +381,7 @@ If you have providers as list of provider ids because you just released them, yo ``` - Copy the documentation to the ``airflow-site`` repository +- Either provide the ``--airflow-site-directory`` flag or set the env variable: ``AIRFLOW_SITE_DIRECTORY`` All providers (including overriding documentation for doc-only changes): @@ -392,8 +393,7 @@ breeze release-management publish-docs \ --package-filter 'apache-airflow-providers-*' \ --override-versioned -cd "${AIRFLOW_SITE_DIRECTORY}" -breeze release-management add-back-references --airflow-site-directory --gen-type providers +breeze release-management add-back-references --airflow-site-directory DIRECTORY --gen-type providers cd .. ``` diff --git a/dev/breeze/src/airflow_breeze/commands/release_management_commands.py b/dev/breeze/src/airflow_breeze/commands/release_management_commands.py index 84fe2517bd8f4..b7ad4bc0f808e 100644 --- a/dev/breeze/src/airflow_breeze/commands/release_management_commands.py +++ b/dev/breeze/src/airflow_breeze/commands/release_management_commands.py @@ -821,7 +821,6 @@ def publish_docs( "--airflow-site-directory", envvar="AIRFLOW_SITE_DIRECTORY", help="Local directory path of cloned airflow-site repo.", - required=True, ) @click.option( "-g", diff --git a/images/breeze/output-commands-hash.txt b/images/breeze/output-commands-hash.txt index 1889686688c7e..c729a6bd450ff 100644 --- a/images/breeze/output-commands-hash.txt +++ b/images/breeze/output-commands-hash.txt @@ -35,7 +35,7 @@ prod-image:build:58ab53c2f5e799bbe05d6fac26d001bf prod-image:pull:76f1f27e6119928412abecf153fce4bb prod-image:verify:bd2b78738a7c388dbad6076c41a9f906 prod-image:a434391e2b5201aaeb5c06601485f7bc -release-management:add-back-references:8dab6a30076a55f2d31c6d22a94e0ccb +release-management:add-back-references:51f64e83e28602b1cbfa7a2fb39fd66b release-management:create-minor-branch:a3834afc4aa5d1e98002c9e9e7a9931d release-management:generate-constraints:b8fcaf8f0acd35ed5dbd48659bdb6485 release-management:generate-issue-content-providers:9cea234261547208ac812464d3e4a598 @@ -49,7 +49,7 @@ release-management:release-prod-images:4d85a23a2175bf8894de5aedbdd85614 release-management:start-rc-process:b27bd524dd3c89f50a747b60a7e892c1 release-management:start-release:419f48f6a4ff4457cb9de7ff496aebbe release-management:verify-provider-packages:96dce5644aad6b37080acf77b3d8de3a -release-management:e12492cf058a0c32fc6daecde65a1aef +release-management:3b93ed037297cce71bce0fa1dcf90439 sbom:generate-provider-requirements:1e7609a0ebafb839d30ec90e4254a628 sbom:update-sbom-information:0ce56884e5f842e3e80d6619df1ccc64 sbom:2ac6b8fc1e84428d5588270eb0d84040 diff --git a/images/breeze/output_release-management_add-back-references.svg b/images/breeze/output_release-management_add-back-references.svg index 87839c0041b0f..4b30e015fc461 100644 --- a/images/breeze/output_release-management_add-back-references.svg +++ b/images/breeze/output_release-management_add-back-references.svg @@ -37,9 +37,9 @@ .breeze-release-management-add-back-references-r3 { fill: #d0b344;font-weight: bold } .breeze-release-management-add-back-references-r4 { fill: #68a0b3;font-weight: bold } .breeze-release-management-add-back-references-r5 { fill: #868887 } -.breeze-release-management-add-back-references-r6 { fill: #cc555a } -.breeze-release-management-add-back-references-r7 { fill: #98a84b;font-weight: bold } -.breeze-release-management-add-back-references-r8 { fill: #8d7b39 } +.breeze-release-management-add-back-references-r6 { fill: #98a84b;font-weight: bold } +.breeze-release-management-add-back-references-r7 { fill: #8d7b39 } +.breeze-release-management-add-back-references-r8 { fill: #cc555a } .breeze-release-management-add-back-references-r9 { fill: #8a4346 } @@ -107,14 +107,14 @@ Command to add back references for documentation to make it backward compatible ╭─ Add Back References to Docs ────────────────────────────────────────────────────────────────────────────────────────╮ -│*--airflow-site-directory-aLocal directory path of cloned airflow-site repo.(TEXT)[required]│ -│*--gen-type-gType of back references to generate, supports: [airflow | providers | helm](TEXT)│ +│--airflow-site-directory-aLocal directory path of cloned airflow-site repo.(TEXT)│ +│*--gen-type-gType of back references to generate, supports: [airflow | providers | helm](TEXT)│ │[required]                                                                 │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Common options ─────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│--verbose-vPrint verbose information about performed steps.│ -│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ -│--help-hShow this message and exit.│ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ From 1e60a1b67325ab6a0c8692c06925125886be0a0e Mon Sep 17 00:00:00 2001 From: Amogh Date: Mon, 17 Jul 2023 19:54:28 +0530 Subject: [PATCH 2/5] review comments from potiuk and eladkal --- dev/README_RELEASE_AIRFLOW.md | 3 +-- dev/README_RELEASE_HELM_CHART.md | 3 +-- dev/README_RELEASE_PROVIDER_PACKAGES.md | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/dev/README_RELEASE_AIRFLOW.md b/dev/README_RELEASE_AIRFLOW.md index db4ecb23a4748..06d98041fd14c 100644 --- a/dev/README_RELEASE_AIRFLOW.md +++ b/dev/README_RELEASE_AIRFLOW.md @@ -802,11 +802,10 @@ Documentation for providers can be found in the ``/docs/apache-airflow`` directo ``` - Copy the documentation to the ``airflow-site`` repository, create commit, push changes, open a PR and merge it when the build is green. -- Either provide the ``--airflow-site-directory`` flag or set the env variable: ``AIRFLOW_SITE_DIRECTORY`` ```shell script breeze release-management publish-docs --package-filter apache-airflow --package-filter docker-stack - breeze release-management add-back-references --airflow-site-directory DIRECTORY --gen-type airflow + breeze release-management add-back-references --gen-type airflow git add . git commit -m "Add documentation for Apache Airflow ${VERSION}" git push diff --git a/dev/README_RELEASE_HELM_CHART.md b/dev/README_RELEASE_HELM_CHART.md index de41cc9472072..a9a39438c1c52 100644 --- a/dev/README_RELEASE_HELM_CHART.md +++ b/dev/README_RELEASE_HELM_CHART.md @@ -631,10 +631,9 @@ between the two repositories to be able to build the documentation. - Update `index.yaml` Regenerate `index.yaml` so it can be added to the Airflow website to allow: `helm repo add https://airflow.apache.org`. - Note: Either provide the ``--airflow-site-directory`` flag or set the env variable: ``AIRFLOW_SITE_DIRECTORY`` ```shell - breeze release-management add-back-references --airflow-site-directory DIRECTORY --gen-type helm + breeze release-management add-back-references --gen-type helm cd .. curl https://dist.apache.org/repos/dist/dev/airflow/helm-chart/$RC/index.yaml -o index.yaml cp ${AIRFLOW_SVN_RELEASE_HELM}/${VERSION}/airflow-${VERSION}.tgz . diff --git a/dev/README_RELEASE_PROVIDER_PACKAGES.md b/dev/README_RELEASE_PROVIDER_PACKAGES.md index e7f9d3c742bfd..9deb5d49d6193 100644 --- a/dev/README_RELEASE_PROVIDER_PACKAGES.md +++ b/dev/README_RELEASE_PROVIDER_PACKAGES.md @@ -381,7 +381,6 @@ If you have providers as list of provider ids because you just released them, yo ``` - Copy the documentation to the ``airflow-site`` repository -- Either provide the ``--airflow-site-directory`` flag or set the env variable: ``AIRFLOW_SITE_DIRECTORY`` All providers (including overriding documentation for doc-only changes): @@ -393,7 +392,7 @@ breeze release-management publish-docs \ --package-filter 'apache-airflow-providers-*' \ --override-versioned -breeze release-management add-back-references --airflow-site-directory DIRECTORY --gen-type providers +breeze release-management add-back-references --gen-type providers cd .. ``` From 4969bcc270941cefed7bee443e42ba7c8d0287bc Mon Sep 17 00:00:00 2001 From: Amogh Date: Mon, 17 Jul 2023 19:57:37 +0530 Subject: [PATCH 3/5] review comments from potiuk and eladkal --- dev/README_RELEASE_PROVIDER_PACKAGES.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/dev/README_RELEASE_PROVIDER_PACKAGES.md b/dev/README_RELEASE_PROVIDER_PACKAGES.md index 9deb5d49d6193..3e13d7de9e75d 100644 --- a/dev/README_RELEASE_PROVIDER_PACKAGES.md +++ b/dev/README_RELEASE_PROVIDER_PACKAGES.md @@ -393,8 +393,6 @@ breeze release-management publish-docs \ --override-versioned breeze release-management add-back-references --gen-type providers -cd .. - ``` If you see `ModuleNotFoundError: No module named 'docs'`, set: From 692448e61d11cb1f9bf9f2a2a6ce46eb01202e50 Mon Sep 17 00:00:00 2001 From: Amogh Date: Tue, 18 Jul 2023 00:15:03 +0530 Subject: [PATCH 4/5] testing and fixing issues --- dev/README_RELEASE_HELM_CHART.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev/README_RELEASE_HELM_CHART.md b/dev/README_RELEASE_HELM_CHART.md index a9a39438c1c52..01994e6241a00 100644 --- a/dev/README_RELEASE_HELM_CHART.md +++ b/dev/README_RELEASE_HELM_CHART.md @@ -634,7 +634,6 @@ between the two repositories to be able to build the documentation. ```shell breeze release-management add-back-references --gen-type helm - cd .. curl https://dist.apache.org/repos/dist/dev/airflow/helm-chart/$RC/index.yaml -o index.yaml cp ${AIRFLOW_SVN_RELEASE_HELM}/${VERSION}/airflow-${VERSION}.tgz . helm repo index --merge ./index.yaml . --url "https://downloads.apache.org/airflow/helm-chart/$VERSION" From 1e6467b031c3d57750c55d76927444dd3f749ed8 Mon Sep 17 00:00:00 2001 From: Amogh Date: Tue, 18 Jul 2023 00:37:55 +0530 Subject: [PATCH 5/5] bringing back --- .../commands/release_management_commands.py | 1 + images/breeze/output-commands-hash.txt | 4 ++-- ...ut_release-management_add-back-references.svg | 16 ++++++++-------- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/dev/breeze/src/airflow_breeze/commands/release_management_commands.py b/dev/breeze/src/airflow_breeze/commands/release_management_commands.py index b7ad4bc0f808e..84fe2517bd8f4 100644 --- a/dev/breeze/src/airflow_breeze/commands/release_management_commands.py +++ b/dev/breeze/src/airflow_breeze/commands/release_management_commands.py @@ -821,6 +821,7 @@ def publish_docs( "--airflow-site-directory", envvar="AIRFLOW_SITE_DIRECTORY", help="Local directory path of cloned airflow-site repo.", + required=True, ) @click.option( "-g", diff --git a/images/breeze/output-commands-hash.txt b/images/breeze/output-commands-hash.txt index c729a6bd450ff..1889686688c7e 100644 --- a/images/breeze/output-commands-hash.txt +++ b/images/breeze/output-commands-hash.txt @@ -35,7 +35,7 @@ prod-image:build:58ab53c2f5e799bbe05d6fac26d001bf prod-image:pull:76f1f27e6119928412abecf153fce4bb prod-image:verify:bd2b78738a7c388dbad6076c41a9f906 prod-image:a434391e2b5201aaeb5c06601485f7bc -release-management:add-back-references:51f64e83e28602b1cbfa7a2fb39fd66b +release-management:add-back-references:8dab6a30076a55f2d31c6d22a94e0ccb release-management:create-minor-branch:a3834afc4aa5d1e98002c9e9e7a9931d release-management:generate-constraints:b8fcaf8f0acd35ed5dbd48659bdb6485 release-management:generate-issue-content-providers:9cea234261547208ac812464d3e4a598 @@ -49,7 +49,7 @@ release-management:release-prod-images:4d85a23a2175bf8894de5aedbdd85614 release-management:start-rc-process:b27bd524dd3c89f50a747b60a7e892c1 release-management:start-release:419f48f6a4ff4457cb9de7ff496aebbe release-management:verify-provider-packages:96dce5644aad6b37080acf77b3d8de3a -release-management:3b93ed037297cce71bce0fa1dcf90439 +release-management:e12492cf058a0c32fc6daecde65a1aef sbom:generate-provider-requirements:1e7609a0ebafb839d30ec90e4254a628 sbom:update-sbom-information:0ce56884e5f842e3e80d6619df1ccc64 sbom:2ac6b8fc1e84428d5588270eb0d84040 diff --git a/images/breeze/output_release-management_add-back-references.svg b/images/breeze/output_release-management_add-back-references.svg index 4b30e015fc461..87839c0041b0f 100644 --- a/images/breeze/output_release-management_add-back-references.svg +++ b/images/breeze/output_release-management_add-back-references.svg @@ -37,9 +37,9 @@ .breeze-release-management-add-back-references-r3 { fill: #d0b344;font-weight: bold } .breeze-release-management-add-back-references-r4 { fill: #68a0b3;font-weight: bold } .breeze-release-management-add-back-references-r5 { fill: #868887 } -.breeze-release-management-add-back-references-r6 { fill: #98a84b;font-weight: bold } -.breeze-release-management-add-back-references-r7 { fill: #8d7b39 } -.breeze-release-management-add-back-references-r8 { fill: #cc555a } +.breeze-release-management-add-back-references-r6 { fill: #cc555a } +.breeze-release-management-add-back-references-r7 { fill: #98a84b;font-weight: bold } +.breeze-release-management-add-back-references-r8 { fill: #8d7b39 } .breeze-release-management-add-back-references-r9 { fill: #8a4346 } @@ -107,14 +107,14 @@ Command to add back references for documentation to make it backward compatible ╭─ Add Back References to Docs ────────────────────────────────────────────────────────────────────────────────────────╮ -│--airflow-site-directory-aLocal directory path of cloned airflow-site repo.(TEXT)│ -│*--gen-type-gType of back references to generate, supports: [airflow | providers | helm](TEXT)│ +│*--airflow-site-directory-aLocal directory path of cloned airflow-site repo.(TEXT)[required]│ +│*--gen-type-gType of back references to generate, supports: [airflow | providers | helm](TEXT)│ │[required]                                                                 │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Common options ─────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│--verbose-vPrint verbose information about performed steps.│ -│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ -│--help-hShow this message and exit.│ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯