diff --git a/dev/README_RELEASE_AIRFLOW.md b/dev/README_RELEASE_AIRFLOW.md index 79d3439b7d533..76033be52b38f 100644 --- a/dev/README_RELEASE_AIRFLOW.md +++ b/dev/README_RELEASE_AIRFLOW.md @@ -712,6 +712,7 @@ As a PMC member, you should be able to clone the SVN repository or update it if you already checked it out: ```shell script +cd ${AIRFLOW_REPO_ROOT} cd .. [ -d asf-dist ] || svn checkout --depth=immediates https://dist.apache.org/repos/dist asf-dist svn update --set-depth=infinity asf-dist/dev/airflow @@ -728,12 +729,12 @@ Optionally you can use the `breeze release-management check-release-files` comma present in SVN. This command may also help with verifying installation of the packages. ```shell script -breeze release-management check-release-files airflow --version ${VERSION_RC} --path-to-airflow-svn "${PATH_TO_AIRFLOW_SVN}" +breeze release-management check-release-files airflow --version ${VERSION_RC} ``` ```shell script -breeze release-management check-release-files task-sdk --version ${TASK_SDK_VERSION_RC} --path-to-airflow-svn "${PATH_TO_AIRFLOW_SVN}/task-sdk" +breeze release-management check-release-files task-sdk --version ${TASK_SDK_VERSION_RC} ``` ## Licence check diff --git a/dev/breeze/doc/09_release_management_tasks.rst b/dev/breeze/doc/09_release_management_tasks.rst index 731942706c72b..3d3108c6df261 100644 --- a/dev/breeze/doc/09_release_management_tasks.rst +++ b/dev/breeze/doc/09_release_management_tasks.rst @@ -94,6 +94,32 @@ When testing from HEAD of the branch when the tag :width: 100% :alt: Breeze release-management prepare-tarball +Validating Release Candidate for PMC +""""""""""""""""""""""""""""""""""""" + +PMC members can use Breeze to automate verification of release candidates instead of manually +running multiple verification steps. This command validates SVN files, GPG signatures, SHA512 +checksums, Apache RAT licenses, and reproducible builds. + +.. code-block:: bash + + breeze release-management validate-rc-by-pmc --distribution airflow --version 3.1.3rc1 --task-sdk-version 1.1.3rc1 --svn-path ~/asf-dist/dev/airflow + +You can run individual checks by specifying the ``--checks`` flag: + +.. code-block:: bash + + breeze release-management validate-rc-by-pmc \ + --distribution airflow \ + --version 3.1.3rc1 \ + --svn-path ~/asf-dist/dev/airflow \ + --checks svn,signatures,checksums,licenses + +.. image:: ./images/output_release-management_validate-rc-by-pmc.svg + :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_release-management_validate-rc-by-pmc.svg + :width: 100% + :alt: Breeze release-management validate-rc-by-pmc + Start minor branch of Airflow """"""""""""""""""""""""""""" @@ -281,10 +307,10 @@ This command can be utilized to manage git tags for providers within the Airflow Sometimes in cases when there is a connectivity issue to GitHub, it might be possible that local tags get created and lead to annoying errors. The default behaviour would be to clean such local tags up. -The flag ``--clean-local-tags`` can be used to delete the local tags. +The flag ``--clean-tags`` can be used to delete the local tags. However, If you want to disable this behaviour, set the envvar CLEAN_LOCAL_TAGS to false or use the -``--no-clean-local-tags`` flag. +``--no-clean-tags`` flag. .. code-block:: bash @@ -381,6 +407,23 @@ You can also add ``--answer yes`` to perform non-interactive build. :width: 100% :alt: Breeze prepare-provider-documentation +Updating provider next version +"""""""""""""""""""""""""""""" + +You can use Breeze to update references to other providers automatically to the +next version of dependent providers, when they are commented with ``# use next version``. + +The below example perform the upgrade. + +.. code-block:: bash + + breeze release-management update-providers-next-version + + +.. image:: ./images/output_release-management_update-providers-next-version.svg + :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_release-management_update-providers-next-version.svg + :alt: Breeze update-providers-next-version + Preparing providers """"""""""""""""""" @@ -428,7 +471,7 @@ Installing providers """""""""""""""""""" In some cases we want to just see if the providers generated can be installed with Airflow without -verifying them. This happens automatically on CI for sdist pcackages but you can also run it manually if you +verifying them. This happens automatically on CI for ``sdist`` packages but you can also run it manually if you just prepared providers and they are present in ``dist`` folder. .. code-block:: bash diff --git a/dev/breeze/doc/images/output_release-management.svg b/dev/breeze/doc/images/output_release-management.svg index a58d6ee577c13..4b0ea7d3f6f34 100644 --- a/dev/breeze/doc/images/output_release-management.svg +++ b/dev/breeze/doc/images/output_release-management.svg @@ -1,4 +1,4 @@ - +