From 57549c1ce7976b3afddc25ba6580eb4556d09ec3 Mon Sep 17 00:00:00 2001 From: Shahar Epstein <60007259+shahar1@users.noreply.github.com> Date: Sat, 2 May 2026 15:05:28 +0300 Subject: [PATCH] [v3-2-test] Clarify 'Fixing released docs' section to cover failed initial publish case (#66253) (cherry picked from commit 865718c7d97129f4e8e8a6534263ae7bda968bc9) Co-authored-by: Shahar Epstein <60007259+shahar1@users.noreply.github.com> --- dev/README_RELEASE_PROVIDERS.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/dev/README_RELEASE_PROVIDERS.md b/dev/README_RELEASE_PROVIDERS.md index 626effd32109f..c0d4f77f7f70f 100644 --- a/dev/README_RELEASE_PROVIDERS.md +++ b/dev/README_RELEASE_PROVIDERS.md @@ -685,6 +685,14 @@ Or if you just want to publish a few selected providers, you can run: > sleep. This command will run several (3!) workflows from your terminal and this is important to keep > it running until completion. + + +> [!NOTE] +> If the workflow fails because a file it references or executes is missing or has incompatible +> logic in the release tag (e.g. it was added or changed in `main` after the tag was cut), see +> [Fixing released documentation](#fixing-released-documentation) in the Misc section below for +> the `-docs` branch workaround. + There is also a manual way of running the workflows (see at the end of the document, this should normally not be needed unless there is some problem with workflow automation above) @@ -1528,6 +1536,14 @@ Or if you just want to publish a few selected providers, you can run: > sleep. This command will run several (3!) workflows from your terminal and this is important to keep > it running until completion. + + +> [!NOTE] +> If the workflow fails because a file it references or executes is missing or has incompatible +> logic in the release tag (e.g. it was added or changed in `main` after the tag was cut), see +> [Fixing released documentation](#fixing-released-documentation) in the Misc section below for +> the `-docs` branch workaround. + There is also a manual way of running the workflows (see at the end of the document, this should normally not be needed unless there is some problem with workflow automation above) @@ -1692,10 +1708,15 @@ Those processes are related to the release of Airflow but should be run in excep ## Fixing released documentation -Sometimes we want to rebuild the documentation with some fixes that were merged in main, -for example when there are html layout changes or typo fixes, or formatting issue fixes. +This section covers two related scenarios: + +1. **Post-publish fixes** — rebuilding already-published docs with changes merged to `main` after + the release (e.g. HTML layout changes, typo fixes, formatting fixes). +2. **Failed initial publish** — the `publish-docs-to-s3.yml` workflow fails because a file it + references or executes is missing or has incompatible logic in the release tag — e.g. it was + added or significantly changed in `main` after the tag was cut. -In this case the process is as follows: +In both cases the process is as follows: * When you want to re-publish `providers-PROVIDER/X.Y.Z` docs, create (or pull if already created) `providers-PROVIDER/X.Y.Z-docs` branch