You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by po...@apache.org on 2024/02/06 14:58:41 UTC

(airflow) branch main updated: Limit docs publishing tests to canary run (#37196)

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 b37e79293a Limit docs publishing tests to canary run (#37196)
b37e79293a is described below

commit b37e79293a453e9f3bacc539ce04a03126aeef79
Author: Jarek Potiuk <ja...@potiuk.com>
AuthorDate: Tue Feb 6 15:58:34 2024 +0100

    Limit docs publishing tests to canary run (#37196)
    
    Docs publishing step takes a lot of disk space and time to complete, due
    to size of the airflow-site repo. We should limit it to only run for
    canary runs on self-hosted runners.
---
 .github/workflows/ci.yml          | 12 ++++++------
 dev/breeze/doc/ci/05_workflows.md |  5 ++++-
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 5fcc72d961..50a84543aa 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -767,25 +767,25 @@ jobs:
         run: >
           git clone https://github.com/apache/airflow-site.git ${GITHUB_WORKSPACE}/airflow-site &&
           echo "AIRFLOW_SITE_DIRECTORY=${GITHUB_WORKSPACE}/airflow-site" >> "$GITHUB_ENV"
-        if: needs.build-info.outputs.full-tests-needed == 'true'
+        if: needs.build-info.outputs.canary-run == 'true'
       - name: "Publish docs"
         run: >
           breeze release-management publish-docs
           --override-versioned --run-in-parallel
           ${{ needs.build-info.outputs.docs-list-as-string }}
-        if: needs.build-info.outputs.full-tests-needed == 'true'
+        if: needs.build-info.outputs.canary-run == 'true'
       - name: "Generate back references for providers"
         run: breeze release-management add-back-references all-providers
-        if: needs.build-info.outputs.full-tests-needed == 'true'
+        if: needs.build-info.outputs.canary-run == 'true'
       - name: "Generate back references for apache-airflow"
         run: breeze release-management add-back-references apache-airflow
-        if: needs.build-info.outputs.full-tests-needed == 'true'
+        if: needs.build-info.outputs.canary-run == 'true'
       - name: "Generate back references for docker-stack"
         run: breeze release-management add-back-references docker-stack
-        if: needs.build-info.outputs.full-tests-needed == 'true'
+        if: needs.build-info.outputs.canary-run == 'true'
       - name: "Generate back references for helm-chart"
         run: breeze release-management add-back-references helm-chart
-        if: needs.build-info.outputs.full-tests-needed == 'true'
+        if: needs.build-info.outputs.canary-run == 'true'
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@010d0da01d0b5a38af31e9c3470dbfdabdecca3a  # v4.0.1
         if: needs.build-info.outputs.canary-run == 'true' && needs.build-info.outputs.default-branch == 'main'
diff --git a/dev/breeze/doc/ci/05_workflows.md b/dev/breeze/doc/ci/05_workflows.md
index eaa2279262..9ea39709c9 100644
--- a/dev/breeze/doc/ci/05_workflows.md
+++ b/dev/breeze/doc/ci/05_workflows.md
@@ -237,7 +237,7 @@ code.
 | Upgrade checks                  | Performs checks if there are some pending upgrades       |          | Yes      | Yes        | Yes              |
 | Static checks                   | Performs full static checks                              | Yes (6)  | Yes      | Yes        | Yes (7)          |
 | Basic static checks             | Performs basic static checks (no image)                  | Yes (6)  |          |            |                  |
-| Build docs                      | Builds and tests publishing of the documentation         | Yes      | Yes      | Yes        | Yes              |
+| Build docs                      | Builds and tests publishing of the documentation         | Yes      | Yes (11) | Yes        | Yes              |
 | Spellcheck docs                 | Spellcheck docs                                          | Yes      | Yes      | Yes        | Yes              |
 | Tests wheel provider packages   | Tests if provider packages can be built and released     | Yes      | Yes      | Yes        |                  |
 | Tests Airflow compatibility     | Compatibility of provider packages with older Airflow    | Yes      | Yes      | Yes        |                  |
@@ -293,6 +293,9 @@ via `skip-provider-tests` selective check output.
 `(10)` Only run the builds in case PR is run by a committer from
 "apache" repository and in scheduled build.
 
+`(11)` Docs publishing is only done in Canary run, to handle the case where
+cloning whole airflow site on Public Runner cannot complete due to the size of the repository.
+
 ## CodeQL scan
 
 The [CodeQL](https://securitylab.github.com/tools/codeql) security scan