forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ulada Zakharava
committed
Dec 16, 2024
1 parent
83da311
commit 8bed0b4
Showing
2 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
58 changes: 58 additions & 0 deletions
58
docs/apache-airflow-providers-google/deprecation-policy.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
|
||
.. 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:: bash | ||
@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. | ||
- 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters