Skip to content

Commit

Permalink
Remove direction to update provider.yaml for breaking changes (apache…
Browse files Browse the repository at this point in the history
  • Loading branch information
perry2of5 authored Oct 25, 2024
1 parent 31cc0f0 commit f802330
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions contributing-docs/11_provider_packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f802330

Please sign in to comment.