potiuk commented on code in PR #35492:
URL: https://github.com/apache/airflow/pull/35492#discussion_r1385117398
##########
airflow/providers/MANAGING_PROVIDERS_LIFECYCLE.rst:
##########
@@ -285,3 +284,161 @@ main Airflow documentation that involves some steps with
the providers is also w
breeze build-docs --package-filter apache-airflow-providers-<NEW_PROVIDER>
breeze build-docs --package-filter apache-airflow
+
+
+Suspending providers
+====================
+
+As of April 2023, we have the possibility to suspend individual providers, so
that they are not holding
+back dependencies for Airflow and other providers. The process of suspending
providers is described
+in `description of the process
<https://github.com/apache/airflow/blob/main/PROVIDERS.rst#suspending-releases-for-providers>`_
+
+Technically, suspending a provider is done by setting ``suspended : true``, in
the provider.yaml of the
+provider. This should be followed by committing the change and either
automatically or manually running
+pre-commit checks that will either update derived configuration files or ask
you to update them manually.
+Note that you might need to run pre-commit several times until all the static
checks pass,
+because modification from one pre-commit might impact other pre-commits.
+
+If you have pre-commit installed, pre-commit will be run automatically on
commit. If you want to run it
+manually after commit, you can run it via ``breeze static-checks
--last-commit`` some of the tests might fail
+because suspension of the provider might cause changes in the dependencies, so
if you see errors about
+missing dependencies imports, non-usable classes etc., you will need to build
the CI image locally
+via ``breeze build-image --python 3.8 --upgrade-to-newer-dependencies`` after
the first pre-commit run
+and then run the static checks again.
+
+If you want to be absolutely sure to run all static checks you can always do
this via
+``pre-commit run --all-files`` or ``breeze static-checks --all-files``.
+
+Some of the manual modifications you will have to do (in both cases
``pre-commit`` will guide you on what
+to do.
+
+* You will have to run ``breeze setup regenerate-command-images`` to
regenerate breeze help files
+* you will need to update ``extra-packages-ref.rst`` and in some cases - when
mentioned there explicitly -
+ ``setup.py`` to remove the provider from list of dependencies.
+
+What happens under-the-hood as the result, is that
``generated/providers.json`` file is updated with
Review Comment:
```suggestion
What happens under-the-hood as a result, is that
``generated/providers.json`` file is updated with
```
--
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]
