eladkal commented on code in PR #37239: URL: https://github.com/apache/airflow/pull/37239#discussion_r1482637473
########## contributing-docs/11_provider_packages.rst: ########## @@ -228,6 +228,39 @@ providers. * System Tests which provide end-to-end testing, usually testing together several operators, sensors, transfers connecting to a real external system +Breaking changes in the community managed providers +--------------------------------------------------- + +Sometimes we have to introduce breaking changes in the providers. We have to be very careful with that +and we have to make sure that we communicate those changes properly. + +Generally speaking breaking change in provider is not a huge problem for our users. They can individually +downgrade the providers to lower version if they are not ready to upgrade to the new version and then +incrementally upgrade to the new versions of providers. This is because providers are installed as +separate packages and they are not tightly coupled with the core of Airflow and because we have a very +generous policy of supporting multiple versions of providers at the same time. All providers are in theory +backward compatible with future versions of Airflow, so you can upgrade Airflow and keep the providers +at the same version. + +When you introduce a breaking change in the provider, you have to make sure that you communicate it +properly. You have to update ``CHANGELOG.rst`` file in the provider package and you have to make sure that +you update the ``provider.yaml`` file with the new (breaking) version of the provider. Ideally in the +``CHANGELOG.rst`` you should also provide a migration path for the users to follow. + +If in doubt, you can always look at ``CHANGELOG.rst`` in other providers to see how we communicate +breaking changes in the providers. + Review Comment: ```suggestion It's important to note that the marking release as breaking / major is subject to the judgment of release manager upon preparing the release. ``` -- 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]
