Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove direction to update provider.yaml for breaking changes #43387

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Remove direction to update provider.yaml for breaking changes #43387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions contributing-docs/11_provider_packages.rst
View file
Open in desktop
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