This is an automated email from the ASF dual-hosted git repository.
shahar1 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 2bf98e865e4 Fix wrong claims and a broken link in providers release
docs (#76993)
2bf98e865e4 is described below
commit 2bf98e865e42fdefea042afb11d73fa932234cd0
Author: Niko Oliveira <[email protected]>
AuthorDate: Thu Nov 12 22:10:31 2026 -0700
Fix wrong claims and a broken link in providers release docs (#76993)
* Fix wrong flag and broken link in providers docs publishing steps
The live docs step named a flag that does not exist, and both docs
steps pointed to a manual section at the end of the guide that does
not exist.
* Fix tag-providers description in providers release docs
The docs said the command cleans up local tags and that a
CLEAN_LOCAL_TAGS variable turns this off. Neither is true: by default
it force-recreates and force-pushes every tag, so a re-run after a
successful push changes the tag dates that the provider metadata uses
as release dates. The breeze docs example also left out the required
release date.
---
dev/README_RELEASE_PROVIDERS.md | 21 ++++++++++++---------
dev/breeze/doc/09_release_management_tasks.rst | 14 ++++++--------
2 files changed, 18 insertions(+), 17 deletions(-)
diff --git a/dev/README_RELEASE_PROVIDERS.md b/dev/README_RELEASE_PROVIDERS.md
index d8430a53446..2d64f85eda5 100644
--- a/dev/README_RELEASE_PROVIDERS.md
+++ b/dev/README_RELEASE_PROVIDERS.md
@@ -1132,8 +1132,9 @@ Or if you just want to publish a few selected providers,
you can run:
> [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)
+You can also run each workflow by hand from the GitHub UI, as described in
+[Publishing the documentation by the release
manager](../docs/README.md#publishing-the-documentation-by-the-release-manager).
+This should normally not be needed unless there is some problem with the
workflow automation above.
## Prepare issue in GitHub to keep status of testing
@@ -2073,10 +2074,11 @@ at `apache/airflow`, so it also works for
release-manager setups where the
apache/airflow clone is configured as `origin`. Set tags for the providers in
the
repository.
-Sometimes in cases when there is a connectivity issue to GitHub, it might be
possible that local tags get created
-and lead to annoying errors. The default behavior would be to clean such local
tags up.
-
-If you want to disable this behavior, set the env **CLEAN_LOCAL_TAGS** to
false.
+By default (`--clean-tags`), the command recreates tags that already exist and
force-pushes them, so
+you can re-run it after a failed push. Don't re-run it after a successful
push: it would replace every
+published tag with a new tag object and change the tag dates that the provider
metadata uses as release
+dates. Pass `--no-clean-tags` (or set `CLEAN_TAGS=false`) to make it stop at
the first tag that already
+exists locally.
As when [pushing the RC tags](#push-the-rc-tags), check out the wave tag first
— `tag-providers`
tags `HEAD`, so the final tags must be created from the wave commit and not
from whatever the
@@ -2176,7 +2178,7 @@ If the wave releases a provider for the first time, open
the `apache/airflow-sit
command fails otherwise, and lists the PR to merge when it completes - see
[Update airflow-site index for new
providers](#update-airflow-site-index-for-new-providers).
-If you need to exclude some providers from the documentation you need to add
`--exclude-providers` flag
+If you need to exclude some providers from the documentation you need to add
`--exclude-docs` flag
with space separated list of excluded providers.
```shell script
@@ -2202,8 +2204,9 @@ Or if you just want to publish a few selected providers,
you can run:
> [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)
+You can also run each workflow by hand from the GitHub UI, as described in
+[Publishing the documentation by the release
manager](../docs/README.md#publishing-the-documentation-by-the-release-manager).
+This should normally not be needed unless there is some problem with the
workflow automation above.
> [!NOTE]
> The **Provider Registry** at `airflow.apache.org/registry/` is rebuilt
> automatically as part of the
diff --git a/dev/breeze/doc/09_release_management_tasks.rst
b/dev/breeze/doc/09_release_management_tasks.rst
index 16b2aa2488a..f2aba0f83f3 100644
--- a/dev/breeze/doc/09_release_management_tasks.rst
+++ b/dev/breeze/doc/09_release_management_tasks.rst
@@ -358,17 +358,15 @@ Adding git tags for providers
"""""""""""""""""""""""""""""
This command can be utilized to manage git tags for providers within the
Airflow remote repository during provider releases.
-Sometimes in cases when there is a connectivity issue to GitHub, it might be
possible that local tags get created and lead to annoying errors.
-The default behaviour would be to clean such local tags up.
-
-The flag ``--clean-tags`` can be used to delete the local tags.
-
-However, If you want to disable this behaviour, set the envvar
CLEAN_LOCAL_TAGS to false or use the
-``--no-clean-tags`` flag.
+By default (``--clean-tags``), the command recreates tags that already exist
and force-pushes them, so
+you can re-run it after a failed push. Don't re-run it after a successful
push: it would replace every
+published tag with a new tag object and change the tag dates that the provider
metadata uses as release
+dates. Pass ``--no-clean-tags`` (or set ``CLEAN_TAGS=false``) to make it stop
at the first tag that already
+exists locally.
.. code-block:: bash
- breeze release-management tag-providers
+ breeze release-management tag-providers --release-date YYYY-MM-DD
These are all of the available flags for the ``tag-providers`` command: