Skip to content

Refine the execution api versioning doc to reflect reality #51152

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

Merged
amoghrajesh merged 1 commit into from
May 28, 2025
Merged

Refine the execution api versioning doc to reflect reality #51152

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
11 changes: 8 additions & 3 deletions contributing-docs/19_execution_api_versioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,14 @@ Why?
----

Airflow components (e.g., workers, API servers) could be deployed independently. This can lead
to version mismatches—for example, a worker using Task SDK 1.0.1 (requiring Airflow >=3.0.1) while the
API server is still on 3.0.0. Without versioning, such mismatches can cause runtime failures or subtle bugs.
A strict versioning model allows older clients to continue working with newer servers, enabling safe, incremental upgrades.
to version mismatches—for example, a worker using Task SDK 1.0.0 (requiring Airflow >=3.0.0) while the
API server has been upgraded to 3.0.1. Without versioning, such mismatches can cause runtime failures or subtle bugs.
Enforcing a clear versioning contract ensures backward compatibility and allows for safe, incremental upgrades
across different components.

Note: We're prioritizing backward compatibility, older clients should continue to work seamlessly with newer servers.
Since the client (Task SDK) and server (API) are still coupled, we can look at forward compatibility once we have a
clear versioning strategy between Task SDK and Airflow Core.

Versioning Principles
---------------------
Expand Down