Skip to content

Commit f4713de

Browse files
authored
Docs: Add RC shortcut for first release candidates from test branch (#64528)
* Docs: Add RC shortcut for first release candidates from test branch * Add RC shortcut docs to release instructions and fix pip install command
1 parent c7fc3b8 commit f4713de

2 files changed

Lines changed: 24 additions & 2 deletions

File tree

dev/README_AIRFLOW3_DEV.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,17 @@ If you want to have a fix backported to 3.2.x please add (or request to add) "ba
7272
When preparing a new 3.2.x release, the release manager will sync the `v3-2-test` branch to `v3-2-stable` and cut the release from the stable branch.
7373
PRs should **never** target `v3-2-stable` directly unless explicitly instructed by the release manager.
7474

75+
> [!TIP]
76+
> **Shortcut for first RC candidates:** When preparing the first RC candidate for a new minor release
77+
> (e.g., 3.2.0rc1), it is unlikely to be approved on the first attempt — bugs are typically found during
78+
> RC testing. In this case, the release manager can prepare the RC directly from the `v3-X-test` branch
79+
> without opening a PR to `v3-X-stable`. This saves the overhead of creating and managing a PR that will
80+
> likely need additional changes before GA. However, when using this shortcut, the release manager **must**
81+
> verify that the `v3-X-test` push CI action ("Tests" workflow) has succeeded before cutting the RC. You can
82+
> check this at:
83+
> https://github.com/apache/airflow/actions/workflows/ci-amd-arm.yml?query=event%3Apush+branch%3Av3-2-test
84+
> (adjust the branch filter for the relevant `v3-X-test` branch).
85+
7586
## Developing for Airflow 3
7687

7788
PRs should target `main` branch.

dev/README_RELEASE_AIRFLOW.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -501,10 +501,21 @@ uv tool install -e ./dev/breeze
501501

502502
- PR from the 'test' branch to the 'stable' branch
503503

504-
- When the PR is approved, install `dev/breeze` in a virtualenv:
504+
> [!TIP]
505+
> **Shortcut for first RC candidates:** When preparing the first RC candidate for a new minor release
506+
> (e.g., 3.2.0rc1), it is unlikely to be approved on the first attempt — bugs are typically found during
507+
> RC testing. In this case, the release manager can prepare the RC directly from the `v3-X-test` branch
508+
> without opening a PR to `v3-X-stable`. This saves the overhead of creating and managing a PR that will
509+
> likely need additional changes before GA. However, when using this shortcut, the release manager **must**
510+
> verify that the `v3-X-test` push CI action ("Tests" workflow) has succeeded before cutting the RC. You can
511+
> check this at:
512+
> https://github.com/apache/airflow/actions/workflows/ci-amd-arm.yml?query=event%3Apush+branch%3Av3-2-test
513+
> (adjust the branch filter for the relevant `v3-X-test` branch).
514+
515+
- When the PR is approved (or when using the shortcut above), install `dev/breeze` in a virtualenv:
505516

506517
```shell script
507-
pip install -e ./dev/breeze
518+
uv pip install -e ./dev/breeze
508519
```
509520

510521
- Set `GITHUB_TOKEN` environment variable. Needed in patch release for generating issue for testing of the RC.

0 commit comments

Comments
 (0)