potiuk commented on code in PR #36763: URL: https://github.com/apache/airflow/pull/36763#discussion_r1451747531
########## dev/README_RELEASE_PYTHON_CLIENT.md: ########## @@ -0,0 +1,588 @@ +<!-- + 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. + --> + +<!-- START doctoc generated TOC please keep comment here to allow auto update --> +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Release Process](#release-process) + - [Prepare PyPI convenience "RC" packages](#prepare-pypi-convenience-rc-packages) + - [Prepare Vote email on the Airflow Client release candidate](#prepare-vote-email-on-the-airflow-client-release-candidate) +- [Verify the release candidate by PMC members](#verify-the-release-candidate-by-pmc-members) + - [SVN check](#svn-check) + - [Reproducible package check](#reproducible-package-check) + - [Signature check](#signature-check) + - [SHA512 checksum check](#sha512-checksum-check) +- [Verify release candidates by Contributors](#verify-release-candidates-by-contributors) + - [Testing with Breeze's start-airflow](#testing-with-breezes-start-airflow) +- [Publish the final Apache Airflow client release](#publish-the-final-apache-airflow-client-release) + - [Summarize the voting for the Apache Airflow client release](#summarize-the-voting-for-the-apache-airflow-client-release) + - [Publish release to SVN](#publish-release-to-svn) + - [Prepare PyPI "release" packages](#prepare-pypi-release-packages) + - [Create release on GitHub](#create-release-on-github) + - [Notify developers of release](#notify-developers-of-release) + - [Add release data to Apache Committee Report Helper](#add-release-data-to-apache-committee-report-helper) + +<!-- END doctoc generated TOC please keep comment here to allow auto update --> + +# Release Process + +The client versioning is independent of the Airflow versioning. + +The Python client is generated using Airflow's [openapi spec](https://github.com/apache/airflow/blob/master/clients/gen/python.sh). +To update the client for new APIs do the following steps: + +```bash +- Checkout the v2-*-test branch of Airflow where you generate the client from + +```bash +# If you have not done so yet +git clone [email protected]/apache/airflow +cd airflow +# Checkout the right branch +git checkout v2-8-test +export AIRFLOW_REPO_ROOT=$(pwd -P) +cd .. +``` + +- Checkout the right branch (usually main) of the Airflow Python client where you + generate the source code to + +```bash +# If you have not done so yet +git clone [email protected]/apache/airflow-client-python +cd airflow-client-python +# Checkout the right branch +git checkout main +export CLIENT_REPO_ROOT=$(pwd -P) +cd .. +``` + +- Set your version in `clients/python/version.txt` in the **Airflow** repository. + Set the `VERSION` and `VERSION_SUFFIX` environment variables. Note that version.txt should contain + the target version - without the suffix. + +```bash +cd ${AIRFLOW_REPO_ROOT} +VERSION="2.8.0" +VERSION_SUFFIX="rc1" +echo "${VERSION}" > clients/python/version.txt +``` + +- Get a diff between the last airflow version and the current airflow version + which this release is based on: + +```shell script +cd ${AIRFLOW_REPO_ROOT} +git log 2.3.0..HEAD --pretty=oneline -- airflow/api_connexion/openapi/v1.yaml +``` + +- Update CHANGELOG.md with the details. + +- Create PR and merge it to the `v2-*-stable` branch. Review Comment: That's one of the big changes here. You will now release from the Airflow repo (because this is where the open API specification is about - the Python client will be merely the repository of generated source code - for anyone to look at (they will also be able to build their client from there as well, but the whole "generale + package" right now will be done in the Airflow repo (no generated code of the client will be kept in the repo though). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
