README.md<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
Table of contents
The Apache Airflow releases are one of the two types:
This package contains sources that allow the user building fully-functional Apache Airflow 2.0 package. They contain sources for:
In the future (Airflow 2.0) this package will be split into separate “core” and “providers” packages that will be distributed separately, following the mechanisms introduced in Backport Package Providers. We also plan to release the official Helm Chart sources that will allow the user to install Apache Airflow via helm 3.0 chart in a distributed fashion.
The Source releases are the only “official” Apache Software Foundation releases, and they are distributed via Official Apache Download sources
Following source releases Apache Airflow release manager also distributes convenience packages:
Those convenience packages are not “official releases” of Apache Airflow, but the users who cannot or do not want to build the packages themselves can use them as a convenient way of installing Apache Airflow, however they are not considered as “official source releases”. You can read more details about it in the ASF Release Policy.
Detailed instruction of releasing Provider Packages can be found in the README_RELEASE_AIRFLOW.md
The person acting as release manager has to fulfill certain pre-requisites. More details and FAQs are available in the ASF Release Policy but here some important pre-requisites are listed below. Note that release manager does not have to be a PMC - it is enough to be committer to assume the release manager role, but there are final steps in the process (uploading final releases to SVN) that can only be done by PMC member. If needed, the release manager can ask PMC to perform that final step of release.
Make sure your public key is on id.apache.org and in KEYS. You will need to sign the release artifacts with your pgp key. After you have created a key, make sure you:
# Create PGP Key gpg --gen-key # Checkout ASF dist repo svn checkout https://dist.apache.org/repos/dist/release/airflow cd airflow # Add your GPG pub key to KEYS file. Replace "Kaxil Naik" with your name (gpg --list-sigs "Kaxil Naik" && gpg --armor --export "Kaxil Naik" ) >> KEYS # Commit the changes svn commit -m "Add PGP keys of Airflow developers"
See this for more detail on creating keys and what is required for signing releases.
http://www.apache.org/dev/release-signing.html#basic-facts
In order to not reveal your password in plain text, it's best if you create and configure API Upload tokens. You can add and copy the tokens here:
Create a ~/.pypirc file:
[distutils] index-servers = pypi pypitest [pypi] username=__token__ password=<API Upload Token> [pypitest] repository=https://test.pypi.org/legacy/ username=__token__ password=<API Upload Token>
Set proper permissions for the pypirc file:
chmod 600 ~/.pypirc
pip install twine
(more details here.)
$ chmod 600 ~/.pypircThe best way to prepare and verify the releases is to prepare them on a hardware owned and controlled by the committer acting as release manager. While strictly speaking, releases must only be verified on hardware owned and controlled by the committer, for practical reasons it's best if the packages are prepared using such hardware. More information can be found in this FAQ