eladkal commented on code in PR #44985: URL: https://github.com/apache/airflow/pull/44985#discussion_r1888506052
########## docs/apache-airflow-providers-google/deprecation-policy.rst: ########## @@ -0,0 +1,57 @@ + + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE + OVERWRITTEN WHEN PREPARING PACKAGES. + + .. IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE + `PROVIDER_CHANGELOG_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY + +Deprecation policy for apache-airflow-providers-google package +---------------------------------------------------------------- + +Versioning of the package +````````````````````````` + +As mentioned in `Airflow's release process and version policy <https://airflow.apache.org/docs/apache-airflow/stable/release-process.html#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: + + .. code-block:: python + + from airflow.providers.google.common.deprecated import deprecated + + @deprecated( + planned_removal_date="September 30, 2025", + use_instead="airflow.providers.google.cloud.hooks.vertex_ai.auto_ml.AutoMLHook, " + category=AirflowProviderDeprecationWarning, + ) + + + - 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 +````````````````````````` + - Bumping a major version of the Airflow google provider package will happen once a month and everything that reached its deprecation removal date will be removed. Review Comment: We normally don't do that. We remove code and cut breaking change release only when we have to. We don't normally cut a breaking change release just to remove things. Release needs to have value. The contract should be users should not relay on the code after deprecation date passed regardless if we removed it or not. We remove at the first chance we have after the specified date. -- 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]
