Draft
Conversation
Document the three deprecation policies enforced by CI: - Deprecation-before-removal (check_sdk_api_breakage.py) - MINOR version bump for breaking changes - Event field deprecation (permanent handlers) Covers the canonical helpers (@deprecated, warn_deprecated), the step-by-step removal workflow, and which packages are covered. Co-authored-by: openhands <openhands@all-hands.dev>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new guide documenting the SDK's deprecation lifecycle and API stability policies.
New file:
sdk/guides/deprecation-policy.mdxWhat's covered
Public API surface — which packages are covered (
openhands-sdk,openhands-workspace) and how__all__defines the boundary.Deprecation helpers — usage of
@deprecateddecorator andwarn_deprecated()function fromopenhands.sdk.utils.deprecation.Policy: Deprecation before removal — symbols must be deprecated for at least one release before being removed from
__all__. Enforced bycheck_sdk_api_breakage.py.Policy: MINOR version bump — any breaking change requires ≥ MINOR bump. Enforced by the same script using Griffe.
Policy: Event field deprecation — special handling for Pydantic event models where deprecated field handlers must be permanent to ensure old events always deserialize.
CI checks — summary of
check_sdk_api_breakage.py(release PRs) andcheck_deprecations.py(every PR).Related PRs
@enyst can click here to continue refining the PR