Skip to content

Commit 3928eec

Browse files
Update "Release Airflow" doc (#19111)
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
1 parent c14aed3 commit 3928eec

File tree

1 file changed

+52
-22
lines changed

1 file changed

+52
-22
lines changed

dev/README_RELEASE_AIRFLOW.md

+52-22
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@
4242
- [Publish documentation](#publish-documentation)
4343
- [Notify developers of release](#notify-developers-of-release)
4444
- [Update Announcements page](#update-announcements-page)
45+
- [Update the bug issue template](#update-the-bug-issue-template)
46+
- [Update default Airflow version in the helm chart](#update-default-airflow-version-in-the-helm-chart)
4547
- [Update airflow/config_templates/config.yml file](#update-airflowconfig_templatesconfigyml-file)
4648

4749
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -171,7 +173,7 @@ branches: `vX-Y-test` and `vX-Y-stable` (for example with `2.1.0rc1` release you
171173
172174
```shell script
173175
# First clone the repo
174-
BRANCH_PREFIX=v2-1
176+
export BRANCH_PREFIX=v2-1
175177
git branch ${BRANCH_PREFIX}-test
176178
git branch ${BRANCH_PREFIX}-stable
177179
git push origin ${BRANCH_PREFIX}-test ${BRANCH_PREFIX}-stable
@@ -252,24 +254,32 @@ also performs image verification before pushing the images.
252254
253255
Subject:
254256
255-
```
256-
[VOTE] Release Airflow 2.0.2 from 2.0.2rc1
257+
```shell script
258+
cat <<EOF
259+
[VOTE] Release Airflow ${VERSION_WITHOUT_RC} from ${VERSION}
260+
EOF
257261
```
258262
259263
Body:
260264
261-
```
265+
```shell script
266+
cat <<EOF
262267
Hey fellow Airflowers,
263268
264-
I have cut Airflow 2.0.2 RC3. This email is calling a vote on the release,
265-
which will last for 72 hours. Consider this my (binding) +1.
269+
I have cut Airflow ${VERSION}. This email is calling a vote on the release,
270+
which will last for 72 hours, from Friday, October 8, 2021 at 4:00 pm UTC
271+
until Monday, October 11, 2021 at 4:00 pm UTC, or until 3 binding +1 votes have been received.
272+
273+
https://www.timeanddate.com/worldclock/fixedtime.html?msg=8&iso=20211011T1600&p1=1440
274+
275+
Consider this my (binding) +1.
266276
267-
Airflow 2.0.2 RC3 is available at:
268-
https://dist.apache.org/repos/dist/dev/airflow/2.0.2rc3/
277+
Airflow ${VERSION} is available at:
278+
https://dist.apache.org/repos/dist/dev/airflow/$VERSION/
269279
270-
*apache-airflow-2.0.2-source.tar.gz* is a source release that comes with INSTALL instructions.
271-
*apache-airflow-2.0.2.tar.gz* is the binary Python "sdist" release.
272-
*apache_airflow-2.0.2-py3-none-any.wh*l is the binary Python wheel "binary" release.
280+
*apache-airflow-${VERSION_WITHOUT_RC}-source.tar.gz* is a source release that comes with INSTALL instructions.
281+
*apache-airflow-${VERSION_WITHOUT_RC}.tar.gz* is the binary Python "sdist" release.
282+
*apache_airflow-${VERSION_WITHOUT_RC}-py3-none-any.whl* is the binary Python wheel "binary" release.
273283
274284
Public keys are available at:
275285
https://dist.apache.org/repos/dist/release/airflow/KEYS
@@ -280,19 +290,19 @@ Please vote accordingly:
280290
[ ] +0 no opinion
281291
[ ] -1 disapprove with the reason
282292
283-
Only votes from PMC members are binding, but the release manager should encourage members of the community
284-
to test the release and vote with "(non-binding)".
293+
Only votes from PMC members are binding, but all members of the community
294+
are encouraged to test the release and vote with "(non-binding)".
285295
286296
The test procedure for PMCs and Contributors who would like to test this RC are described in
287297
https://github.com/apache/airflow/blob/main/dev/README_RELEASE_AIRFLOW.md#verify-the-release-candidate-by-pmcs
288298
289-
Please note that the version number excludes the `rcX` string, so it's now
290-
simply 2.0.2. This will allow us to rename the artifact without modifying
299+
Please note that the version number excludes the \`rcX\` string, so it's now
300+
simply ${VERSION_WITHOUT_RC}. This will allow us to rename the artifact without modifying
291301
the artifact checksums when we actually release.
292302

293-
Full Changelog: (https://github.com/apache/airflow/blob/2.0.2rc3/CHANGELOG.txt).
303+
Full Changelog: https://github.com/apache/airflow/blob/${VERSION}/CHANGELOG.txt
294304

295-
Changes since 2.0.2rc2:
305+
Changes since ${VERSION}:
296306
*Bugs*:
297307
[AIRFLOW-3732] Fix issue when trying to edit connection in RBAC UI
298308
[AIRFLOW-2866] Fix missing CSRF token head when using RBAC UI (#3804)
@@ -318,6 +328,7 @@ Changes since 2.0.2rc2:
318328
319329
Cheers,
320330
<your name>
331+
EOF
321332
```
322333
323334
@@ -515,7 +526,7 @@ Once the vote has been passed, you will need to send a result vote to dev@airflo
515526
Subject:
516527
517528
```
518-
[RESULT][VOTE] Airflow 2.0.2rc3
529+
[RESULT][VOTE] Release Airflow 2.0.2 from 2.0.2rc3
519530
```
520531
521532
Message:
@@ -572,12 +583,12 @@ export AIRFLOW_DEV_SVN=$(pwd)
572583
# svn checkout https://dist.apache.org/repos/dist/release/airflow airflow-release
573584
cd <YOUR_AIFLOW_RELEASE_SVN>
574585
svn update
586+
export AIRFLOW_RELEASE_SVN=$(pwd)
575587
576588
export RC=2.0.2rc5
577589
export VERSION=${RC/rc?/}
578590
579591
# Create new folder for the release
580-
cd airflow-release
581592
svn mkdir "${VERSION}"
582593
cd "${VERSION}"
583594
@@ -607,7 +618,7 @@ previously released RC candidates in "${AIRFLOW_SOURCES}/dist":
607618
- Verify the artifacts that would be uploaded:
608619
609620
```shell script
610-
cd "${AIRFLOW_SOURCES}"
621+
cd "${AIRFLOW_RELEASE_SVN}/${VERSION}"
611622
twine check dist/*
612623
```
613624
@@ -676,6 +687,7 @@ Documentation for providers can be found in the ``/docs/apache-airflow`` directo
676687
```shell script
677688
git clone https://github.com/apache/airflow-site.git airflow-site
678689
cd airflow-site
690+
git checkout -b ${VERSION}-docs
679691
export AIRFLOW_SITE_DIRECTORY="$(pwd)"
680692
```
681693
@@ -692,13 +704,15 @@ Documentation for providers can be found in the ``/docs/apache-airflow`` directo
692704
./docs/start_doc_server.sh
693705
```
694706
695-
- Copy the documentation to the ``airflow-site`` repository, create commit and push changes.
707+
- Copy the documentation to the ``airflow-site`` repository, create commit, push changes and open a PR.
696708
697709
```shell script
698710
./docs/publish_docs.py --package-filter apache-airflow --package-filter docker-stack
699711
cd "${AIRFLOW_SITE_DIRECTORY}"
712+
git add .
700713
git commit -m "Add documentation for Apache Airflow ${VERSION}"
701714
git push
715+
# and finally open a PR
702716
```
703717
704718
## Notify developers of release
@@ -726,14 +740,20 @@ The released sources and packages can be downloaded via https://airflow.apache.o
726740
727741
Other installation methods are described in https://airflow.apache.org/docs/apache-airflow/stable/installation/
728742
743+
We also made this version available on PyPI for convenience:
744+
\`pip install apache-airflow\`
745+
https://pypi.org/project/apache-airflow/${VERSION}/
746+
729747
The documentation is available on:
730748
https://airflow.apache.org/
731749
https://airflow.apache.org/docs/apache-airflow/${VERSION}/
732750
733751
Find the CHANGELOG here for more details:
734-
735752
https://airflow.apache.org/docs/apache-airflow/${VERSION}/changelog.html
736753
754+
Container images are published at:
755+
https://hub.docker.com/r/apache/airflow/tags/?page=1&name=${VERSION}
756+
737757
Cheers,
738758
<your name>
739759
EOF
@@ -743,6 +763,16 @@ EOF
743763
744764
Update "Announcements" page at the [Official Airflow website](https://airflow.apache.org/announcements/)
745765
766+
## Update the bug issue template
767+
768+
Make sure the version you just released is listed in the bug issue template in `.github/ISSUE_TEMPLATE/airflow_bug_report.yml`.
769+
770+
## Update default Airflow version in the helm chart
771+
772+
Update the values of `airflowVersion`, `defaultAirflowTag` and `appVersion` in the helm chart so the next helm chart release
773+
will use the latest released version. You'll need to update `chart/values.yaml`, `chart/values.schema.json` and
774+
`chart/Chart.yaml`.
775+
746776
## Update airflow/config_templates/config.yml file
747777
748778
File `airflow/config_templates/config.yml` contains documentation on all configuration options available in Airflow. The `version_added` fields must be updated when a new Airflow version is released.

0 commit comments

Comments
 (0)