Skip to content

Update the "releasing Airflow" docs #20456

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
jedcunningham merged 1 commit into from
Dec 22, 2021
Merged

Update the "releasing Airflow" docs #20456

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
20 changes: 10 additions & 10 deletions dev/README_RELEASE_AIRFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ protected_branches:
export BRANCH_PREFIX=2-1
git checkout constraints-main
git checkout -b constraints-${BRANCH_PREFIX}
git push origin constraints-${BRANCH_PREFIX}
git push origin tag constraints-${BRANCH_PREFIX}
```

## Prepare PyPI convenience "snapshot" packages
Expand Down Expand Up @@ -352,7 +352,7 @@ is not supposed to be used by and advertised to the end-users who do not read th
(both airflow and latest provider packages).

```shell script
git push origin ${VERSION}
git push origin tag ${VERSION}
Copy link
Member

@kaxil kaxil Dec 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original should work too

Copy link
Member Author

@jedcunningham jedcunningham Dec 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, but this is safer.

Copy link
Member

@uranusjr uranusjr Dec 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL this is a thing

Copy link
Member

@potiuk potiuk Dec 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Git never ceases to amaze me. Every time I get to do something really complex in git, it really is just a matter of looking hard enough. There has ALWAYS been a one liner (even if a line is long) that does precisely what I wanted to do - no matter how complex the thing was.

```

## Prepare production Docker Image
Expand Down Expand Up @@ -721,8 +721,8 @@ The best way of doing this is to svn cp between the two repos (this avoids havin

```shell script
# GO to Airflow Sources first
cd <YOUR_AIRFLOW_SOURCES>
export AIRFLOW_SOURCES=$(pwd)
cd <YOUR_AIRFLOW_REPO_ROOT>
export AIRFLOW_REPO_ROOT=$(pwd)

# GO to Checked out DEV repo. Should be checked out before via:
# svn checkout https://dist.apache.org/repos/dist/dev/airflow airflow-dev
Expand Down Expand Up @@ -761,8 +761,7 @@ Verify that the packages appear in [airflow](https://dist.apache.org/repos/dist/

## Prepare PyPI "release" packages

At this point we release an official package (they should be copied and renamed from the
previously released RC candidates in "${AIRFLOW_SOURCES}/dist":
At this point we release an official package:

- Verify the artifacts that would be uploaded:

Expand Down Expand Up @@ -794,7 +793,7 @@ previously released RC candidates in "${AIRFLOW_SOURCES}/dist":
cd "${AIRFLOW_REPO_ROOT}"
git checkout constraints-${RC}
git tag -s "constraints-${VERSION}" -m "Constraints for Apache Airflow ${VERSION}"
git push origin "constraints-${VERSION}"
git push origin tag "constraints-${VERSION}"
```

- Push Tag for the final version
Expand All @@ -806,7 +805,7 @@ previously released RC candidates in "${AIRFLOW_SOURCES}/dist":
```shell script
git checkout ${RC}
git tag -s ${VERSION} -m "Apache Airflow ${VERSION}"
git push origin ${VERSION}
git push origin tag ${VERSION}
```

## Manually prepare production Docker Image
Expand Down Expand Up @@ -891,8 +890,7 @@ We also made this version available on PyPI for convenience:
\`pip install apache-airflow\`
https://pypi.org/project/apache-airflow/${VERSION}/

The documentation is available on:
https://airflow.apache.org/
The documentation is available at:
https://airflow.apache.org/docs/apache-airflow/${VERSION}/

Find the CHANGELOG here for more details:
Expand Down Expand Up @@ -968,6 +966,8 @@ Update the values of `airflowVersion`, `defaultAirflowTag` and `appVersion` in t
will use the latest released version. You'll need to update `chart/values.yaml`, `chart/values.schema.json` and
`chart/Chart.yaml`.

Also add a note to `UPDATING.rst` that the default version of Airflow has changed.

## Update airflow/config_templates/config.yml file

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.
Expand Down