Skip to content
oss-kit
GitHubInstall

A public API is deprecated in a release before it is removed

Rule
R-CHG-05
Forge scope
GitHub and GitLab

Removing an API without warning turns an upgrade into an outage. Users need a released version where the old path still works and the interface they use directs them to the replacement.

Observable check

every public item under Removed appeared under Deprecated in an earlier release, stayed usable for the project's stated deprecation window, and produced an interface-appropriate notice naming the replacement or migration path and earliest removal version. For stable SemVer, deprecation ships in a MINOR release and removal waits for a later MAJOR release.

Read the whole standard