Deprecation policy for apache-airflow-providers-google package

Versioning of the package

As mentioned in Airflow’s release process and version policy Google provider package (and others) should follow SemVer, meaning that any breaking changes should be released together with bumping major version of the package. The change is considered to be a breaking if a DAG that was working before stops to work after the change.

Deprecation Procedure

The entire procedure of deprecating (either method, parameter or operator) consists of two steps:

  • Using decorator to mark an object as deprecated, specifying planned removal date and an object that can be used instead of deprecated one:

from airflow.providers.google.common.deprecated import deprecated
from airflow.exceptions import AirflowProviderDeprecationWarning


@deprecated(
    planned_removal_date="September 30, 2025",
    use_instead="airflow.providers.google.cloud.hooks.vertex_ai.auto_ml.AutoMLHook",
    category=AirflowProviderDeprecationWarning,
)
def example() -> None: ...

  • Once the date of the deprecated method/parameter/operator is passed, it can be removed together with bumping major version of the package.

Additional Considerations

  • By default all deprecations should allow a 6 months time period until they will be removed and not available. This period will give Airflow users enough time and flexibility to update their DAGs before actual removal happens. On a case by case basis this period can be adjusted given specific circumstances (e.g. in case deprecation is because of underlying API sunset which can happen earlier than in 6 months).

Was this entry helpful?