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 865718c7d97 Clarify 'Fixing released docs' section to cover failed
initial publish case (#66253)
865718c7d97 is described below
commit 865718c7d97129f4e8e8a6534263ae7bda968bc9
Author: Shahar Epstein <[email protected]>
AuthorDate: Sat May 2 15:05:28 2026 +0300
Clarify 'Fixing released docs' section to cover failed initial publish case
(#66253)
---
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 2e0cdcdd3ff..39c8236afb4 100644
--- a/dev/README_RELEASE_PROVIDERS.md
+++ b/dev/README_RELEASE_PROVIDERS.md
@@ -687,6 +687,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)
@@ -1539,6 +1547,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)
@@ -1703,10 +1719,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
