Skip to content

[v3-2-test] Clarify 'Fixing released docs' section to cover failed initial publish case (#66253) #66271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 1 commit into from
May 2, 2026
Merged

[v3-2-test] Clarify 'Fixing released docs' section to cover failed initial publish case (#66253) #66271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions dev/README_RELEASE_PROVIDERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand Down
Loading