Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions BEFORE_AFTER_COMPARISON.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--
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.
-->
14 changes: 14 additions & 0 deletions dev/README_RELEASE_PROVIDERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down
17 changes: 17 additions & 0 deletions dev/breeze/doc/09_release_management_tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""""""""""""""""""

Expand Down
62 changes: 33 additions & 29 deletions dev/breeze/doc/images/output_release-management.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dev/breeze/doc/images/output_release-management.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
509d258b7e4d9d0bfea9f8628747d676
57618cd70c562779c05317be0c264121
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
91c2333cf1da8fb531655e616dce32d7
Loading
Loading