Deprecations and removals
This page contains information on the deprecation and removal of SonarQube Cloud features and API endpoints.
Deprecation policy
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 the dedicated Deprecation announcements section below.
- 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).
Deprecation announcements
Deprecated build wrapper output property
- Announced in May 2024
- Removal after July 10 2024
Build Wrapper collects information from the build in two separate JSON formats: compile_commands.json
and build-wrapper-dump.json
. Both these files are generated in the specified output directory. The build-wrapper-dump.json
format and its associated property sonar.cfamily.build-wrapper-output
are deprecated. The sonar.cfamily.compile-commands
property should be used instead to specify the path to the compile_commands.json
file.
Additional API updates
When querying rules or issues, INFO and BLOCKER may appear as statuses at the quality level (i.e. a rule might have a reliability severity of BLOCKER). It is also possible to create rules/issues with these additional severities.
The affected APIs:
- api/issues/*
- api/rules/*
- api/projects/export_findings
- api/qualityprofiles/compare
- api/qualityprofiles/changelog
Was this page helpful?