diff --git a/BEFORE_AFTER_COMPARISON.md b/BEFORE_AFTER_COMPARISON.md new file mode 100644 index 0000000000000..ef14affc68c62 --- /dev/null +++ b/BEFORE_AFTER_COMPARISON.md @@ -0,0 +1,18 @@ + diff --git a/dev/README_RELEASE_PROVIDERS.md b/dev/README_RELEASE_PROVIDERS.md index f04e8e80573c4..74fe4fe422f1e 100644 --- a/dev/README_RELEASE_PROVIDERS.md +++ b/dev/README_RELEASE_PROVIDERS.md @@ -29,6 +29,7 @@ - [Prepare Regular Provider distributions (RC)](#prepare-regular-provider-distributions-rc) - [Perform review of security issues that are marked for the release](#perform-review-of-security-issues-that-are-marked-for-the-release) - [Convert commits to changelog entries and bump provider versions](#convert-commits-to-changelog-entries-and-bump-provider-versions) + - [Update versions of dependent providers to the next version](#update-versions-of-dependent-providers-to-the-next-version) - [Apply incremental changes and merge the PR](#apply-incremental-changes-and-merge-the-pr) - [(Optional) Apply template updates](#optional-apply-template-updates) - [Build Provider distributions for SVN apache upload](#build-provider-distributions-for-svn-apache-upload) @@ -221,6 +222,19 @@ The tool determines the new version of provider as follows: * increased minor version if new features are added * increased major version if breaking changes are added +## Update versions of dependent providers to the next version + +Sometimes when contributors want to use next version of a dependent provider, instead of +doing it immediately in the code they can add a comment ``# use next version`` +to the line of ``pyproject.toml`` file of the provider that refers to the provider, which next version +should be used. This comment will be picked up by the``update-providers-next-version`` command and the +version of the dependent provider will be updated to the next version and comment will be +removed. + +```shell script +breeze release-management update-providers-next-version +``` + ## Apply incremental changes and merge the PR When those changes are generated, you should commit the changes, create a PR and get it reviewed. diff --git a/dev/breeze/doc/09_release_management_tasks.rst b/dev/breeze/doc/09_release_management_tasks.rst index 5e12d1a209035..a62b111e022f2 100644 --- a/dev/breeze/doc/09_release_management_tasks.rst +++ b/dev/breeze/doc/09_release_management_tasks.rst @@ -381,6 +381,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 """"""""""""""""""" diff --git a/dev/breeze/doc/images/output_release-management.svg b/dev/breeze/doc/images/output_release-management.svg index abfe13210a472..e0df268e6314d 100644 --- a/dev/breeze/doc/images/output_release-management.svg +++ b/dev/breeze/doc/images/output_release-management.svg @@ -1,4 +1,4 @@ - +