Skip to content

Clarify API deprecation policy - #65093

Merged
bveeramani merged 2 commits into
masterfrom
clarify-api-policy
Jul 29, 2026
Merged

Clarify API deprecation policy#65093
bveeramani merged 2 commits into
masterfrom
clarify-api-policy

Conversation

@bveeramani

Copy link
Copy Markdown
Member

Our current API deprecation policy states that we can deprecate APIs after six months or 25 Ray minor releases. The problem is that it's unclear whether the six months or 25 minor releases takes precedence if we don't release weekly. For example, if we release every month, 25 minor releases is 2+ years.

To resolve this ambiguity, I'm clarifying that the policy is "Six months or 25 Ray minor releases, whichever comes first"

Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
@bveeramani
bveeramani requested review from a team as code owners July 28, 2026 20:44

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the API policy documentation to clarify deprecation and parameter change deadlines by adding the phrase "whichever comes first". A review comment suggests also updating the Beta Public APIs policy on line 79 to include "whichever comes first" for consistency.

Comment thread doc/source/ray-contribute/api-policy.md
@dstrodtman dstrodtman added go add ONLY when ready to merge, run all tests docs-go RtD-only checks for docs-only changes. Doesn't run full library doc-test suites. labels Jul 28, 2026

@dstrodtman dstrodtman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stamped.

docs-go label means tests should pass quickly (<20 minutes for now, trying to get faster), even with an edit.

@ray-gardener ray-gardener Bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Jul 29, 2026
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
@bveeramani
bveeramani enabled auto-merge (squash) July 29, 2026 21:08
@github-actions
github-actions Bot disabled auto-merge July 29, 2026 21:08
@bveeramani
bveeramani merged commit 67fd383 into master Jul 29, 2026
7 checks passed
@bveeramani
bveeramani deleted the clarify-api-policy branch July 29, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core docs An issue or change related to documentation docs-go RtD-only checks for docs-only changes. Doesn't run full library doc-test suites. go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants