Hello SonarCloud users,
I am pleased to announce the SonarCloud Deprecation & Change Policy to you today.
This will help you to be more prepared and easily adapt to deprecations and product changes.
We carefully consider the usage of the existing solution and future direction before deciding to deprecate a feature or API end-point. We are continuously improving SonarCloud, and therefore, we have to sometimes drop features to make room for improved ones.
(We are not planning to drop any features right now. This is just the policy announcement)
What does deprecation mean?
- A backward-incompatible change or dropping of a public API endpoint, a workflow, or a feature can be considered deprecation. Once deprecated, they will be removed after a defined period of time.
- Before making a backward-incompatible change or dropping a public API endpoint, it is marked as obsolete or deprecated. Once deprecated, they will be removed after a defined period of time.
Deprecation timeframe
- When a public API endpoint is to be dropped, SonarSource will announce this at least 180 days before to the users.
- When a feature is to be dropped, SonarSource will announce this at least 90 days before to the users.
- The feature or API endpoint will be removed on the expiry of the deprecation period.
Deprecation communication
- Deprecation notices will be published in SonarCloud documentation under a dedicated deprecation section.
- Users will be notified about an API endpoint deprecation in the Sonar Community. (future deprecation announcements will be available at this link)
- Users (organization owner and token owner if the endpoint is used by the organization) will be notified about the deprecation of an API endpoint via email. If you have used the API endpoint that is about to be deprecated within the last 30 days prior to deprecation, you will receive an email announcing the deprecation.
- A reminder of the deprecation will be delivered through email 90, 60, and 30 days prior to the removal of the endpoint.
- Deprecation of a feature or workflow will be communicated to existing users within the product UI.
- Notification will include the scope of deprecation, timeframe of deprecation, and alternative solution (if available).