This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch v3-0-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/v3-0-test by this push:
new 093d65babf1 Synchronizes release docs and checks between main and
v3-0-test (#54595)
093d65babf1 is described below
commit 093d65babf16c38f2b8f91206ca2c05d440b15cf
Author: Jarek Potiuk <[email protected]>
AuthorDate: Mon Aug 18 08:43:09 2025 +0200
Synchronizes release docs and checks between main and v3-0-test (#54595)
---
.github/workflows/basic-tests.yml | 2 +-
dev/README_RELEASE_PROVIDERS.md | 74 +++++++++++++++++++++++++++++++++------
2 files changed, 64 insertions(+), 12 deletions(-)
diff --git a/.github/workflows/basic-tests.yml
b/.github/workflows/basic-tests.yml
index 3c5440653c6..65215396c05 100644
--- a/.github/workflows/basic-tests.yml
+++ b/.github/workflows/basic-tests.yml
@@ -358,7 +358,7 @@ jobs:
run: |
git remote add apache https://github.com/apache/airflow.git
git fetch apache --tags
- breeze release-management generate-providers-metadata
--refresh-constraints
+ breeze release-management generate-providers-metadata
--refresh-constraints-and-airflow-releases
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Fetch all git tags for origin"
diff --git a/dev/README_RELEASE_PROVIDERS.md b/dev/README_RELEASE_PROVIDERS.md
index ed3e91aaaa8..e26ea76f246 100644
--- a/dev/README_RELEASE_PROVIDERS.md
+++ b/dev/README_RELEASE_PROVIDERS.md
@@ -55,6 +55,7 @@
- [Add release data to Apache Committee Report
Helper](#add-release-data-to-apache-committee-report-helper)
- [Close the testing status issue](#close-the-testing-status-issue)
- [Remove Provider distributions scheduled for
removal](#remove-provider-distributions-scheduled-for-removal)
+ - [Misc / Post Release Helpers](#misc--post-release-helpers)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -411,7 +412,7 @@ If you are seeing others there is an issue.
You can remove the redundant provider files manually with:
```shell script
-svn rm file_name // repeate that for every file
+svn rm file_name // repeat that for every file
svn commit -m "delete old providers"
```
@@ -477,7 +478,7 @@ twine upload -r pypi ${AIRFLOW_REPO_ROOT}/dist/*
Assume that your remote for apache repository is called `apache` you should now
set tags for the providers in the repo.
-Sometimes in cases when there is a connectivity issue to Github, it might be
possible that local tags get created
+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.
If you want to disable this behaviour, set the env **CLEAN_LOCAL_TAGS** to
false.
@@ -508,7 +509,13 @@ The command does the following:
3. Triggers S3 to GitHub Sync
```shell script
- breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
+ breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
all-providers
+```
+
+Or if you just want to publish a few selected providers, you can run:
+
+```shell script
+ breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
PACKAGE1 PACKAGE2 ..
```
The `--ref` parameter should be the tag of the release candidate you are
publishing.
@@ -640,6 +647,14 @@ issue. There is a comment generated with NOTE TO RELEASE
MANAGER about this in t
Hit Preview button on "create issue" screen before creating it to verify how
it will look like
for the contributors.
+By default, the command will output a clickable link to create the issue from
terminal if you don't want this option use --no-include-browser-link flag
+
+```shell script
+cd "${AIRFLOW_REPO_ROOT}"
+
+breeze release-management generate-issue-content-providers
--only-available-in-dist --no-include-browser-link --github-token TOKEN \
+ --excluded-pr-list PR_NUMBER1,PR_NUMBER2
+```
## Prepare voting email for Providers release candidate
@@ -760,13 +775,21 @@ Or update it if you already checked it out:
svn update .
```
+Set an environment variable: PATH_TO_SVN to the root of folder where you clone
the SVN repository:
+
+``` shell
+export PATH_TO_SVN=<set your path to svn here>
+```
+
Optionally you can use the
[`check_files.py`](https://github.com/apache/airflow/blob/main/dev/check_files.py)
script to verify that all expected files are present in SVN. This script will
produce a `Dockerfile.pmc` which
may help with verifying installation of the packages.
+Once you have cloned/updated the SVN repository, copy the pypi URLs shared in
the email to a file called `packages.txt` in the $AIRFLOW_REPO_ROOT/dev
+directory and cd into it.
+
```shell script
-# Copy the list of packages (pypi urls) into `packages.txt` then run:
-python check_files.py providers -p {PATH_TO_SVN}
+uv run check_files.py providers -p ${PATH_TO_SVN}
```
After the above script completes you can build `Dockerfile.pmc` to trigger an
installation of each provider
@@ -820,7 +843,7 @@ breeze release-management prepare-provider-distributions
--include-removed-provi
5) Switch to the folder where you checked out the SVN dev files
```shell
-cd {PATH_TO_SVN}
+cd ${PATH_TO_SVN}
cd airflow/providers
```
@@ -896,7 +919,9 @@ where `.rat-excludes` is the file in the root of Airflow
source code.
Make sure you have imported into your GPG the PGP key of the person signing
the release. You can find the valid keys in
[KEYS](https://dist.apache.org/repos/dist/release/airflow/KEYS).
-You can import the whole KEYS file:
+Download the KEYS file from the above link and save it locally.
+
+You can import the whole KEYS file into gpg by running the following command:
```shell script
gpg --import KEYS
@@ -1010,7 +1035,7 @@ pip install
apache-airflow-providers-<provider>==<VERSION>rc<X>
### Installing with Breeze
```shell
-breeze start-airflow --use-airflow-version 2.2.4 --python 3.9 --backend
postgres \
+breeze start-airflow --use-airflow-version 2.10.3 --python 3.10 --backend
postgres \
--load-example-dags --load-default-connections
```
@@ -1235,7 +1260,7 @@ Copy links to updated packages, sort it alphabetically
and save it on the side.
Assume that your remote for apache repository is called `apache` you should now
set tags for the providers in the repo.
-Sometimes in cases when there is a connectivity issue to Github, it might be
possible that local tags get created
+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.
If you want to disable this behaviour, set the env **CLEAN_LOCAL_TAGS** to
false.
@@ -1266,9 +1291,16 @@ The command does the following:
3. Triggers S3 to GitHub Sync
```shell script
- breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
+ breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
all-providers
+```
+
+Or if you just want to publish a few selected providers, you can run:
+
+```shell script
+ breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
PACKAGE1 PACKAGE2 ..
```
+
The `--ref` parameter should be the tag of the final candidate you are
publishing.
The `--site-env` parameter should be set to `staging` for pre-release versions
or `live` for final releases. the default option is `auto`
@@ -1344,7 +1376,7 @@ git pull apache main
current_date=$(date '+%Y-%m-%d%n')
branch="update-providers-metadata-${current_date}"
git checkout -b "${branch}"
-breeze release-management generate-providers-metadata --refresh-constraints
+breeze release-management generate-providers-metadata
--refresh-constraints-and-airflow-releases
git add -p .
git commit -m "Update providers metadata ${current_date}"
git push --set-upstream origin "${branch}"
@@ -1472,3 +1504,23 @@ The following places should be checked:
Run `breeze setup regenerate-command-images --force`
Update test_get_removed_providers in `/dev/breeze/tests/test_packages.py` by
removing the provider from the list
+
+
+## Misc / Post Release Helpers
+
+In case you need to rebuild docs with addition of a commit that is not part of
the original release use
+
+
+```shell script
+ breeze workflow-run publish-docs --ref <tag> --site-env <staging/live/auto>
PACKAGE1 \
+ --apply-commits <commit_hash> --skip-write-to-stable-folder \
+ PACKAGE1
+```
+
+Example:
+
+```shell script
+breeze workflow-run publish-docs --ref providers-apache-hive/9.0.0 --site-env
live \
+ --apply-commits 4ae273cbedec66c87dc40218c7a94863390a380d
--skip-write-to-stable-folder \
+ apache.hive
+```
