This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new f80233054c2 Remove direction to update provider.yaml for breaking
changes (#43387)
f80233054c2 is described below
commit f80233054c204eace74d54a90e5ae517a8548922
Author: perry2of5 <[email protected]>
AuthorDate: Fri Oct 25 13:48:13 2024 -0700
Remove direction to update provider.yaml for breaking changes (#43387)
---
contributing-docs/11_provider_packages.rst | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/contributing-docs/11_provider_packages.rst
b/contributing-docs/11_provider_packages.rst
index eaecb23b34a..59624f942cb 100644
--- a/contributing-docs/11_provider_packages.rst
+++ b/contributing-docs/11_provider_packages.rst
@@ -243,9 +243,8 @@ backward compatible with future versions of Airflow, so you
can upgrade Airflow
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.
+properly. You have to update ``CHANGELOG.rst`` file in the provider package.
Ideally you should provide
+a migration path for the users to follow in the``CHANGELOG.rst``.
If in doubt, you can always look at ``CHANGELOG.rst`` in other providers to
see how we communicate
breaking changes in the providers.
