https://github.com/sonarsource/sonar-plugin-api
API to develop plugins for SonarQube (Server, Cloud) and SonarQube for IDE
https://github.com/sonarsource/sonar-plugin-api
Last synced: 6 months ago
JSON representation
API to develop plugins for SonarQube (Server, Cloud) and SonarQube for IDE
- Host: GitHub
- URL: https://github.com/sonarsource/sonar-plugin-api
- Owner: SonarSource
- License: lgpl-3.0
- Created: 2022-04-07T09:47:19.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-01T11:49:49.000Z (6 months ago)
- Last Synced: 2025-07-01T12:45:57.496Z (6 months ago)
- Language: Java
- Homepage:
- Size: 1.64 MB
- Stars: 21
- Watchers: 19
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# sonar-plugin-api
Java API to develop plugins for SonarQube (Server, Cloud) and SonarQube for IDE.
This component was extracted out of SonarQube and has been released independently since v9.5.
The API is built with JDK 11.
## Developing plugins
See documentation [here](https://docs.sonarqube.org/latest/extend/developing-plugin/) about how to use the `sonar-plugin-api` to develop plugins.
## Dependency
The API was relocated when it was extracted out of SonarQube. Its new coordinates are:
```
org.sonarsource.api.plugin:sonar-plugin-api:
```
You can find it in [maven central](https://mvnrepository.com/artifact/org.sonarsource.api.plugin/sonar-plugin-api).
Also note that the version no longer follows SonarQube Server's versions. The `sonar-plugin-api` is now released separately.
## Changelogs
See the [releases](https://github.com/SonarSource/sonar-plugin-api/releases) for changelogs.
## Deprecation Policy
See the [deprecation policy](docs/deprecation-policy.md).
## Compatibility
Breaking changes to the API happen when the major version changes. As a result, plugins should be compatible with future versions of the API within the same major version.
New APIs can be introduced in any release of the API, and plugins may want to do a runtime version check to see if they can use newly added APIs, depending on what platforms they intend to run.
The following tables indicate which API versions plugins can find at runtime:
### SonarQube Server
| SonarQube | Plugin API |
|------------------------|---------------------------|
| Server 2025.2.0.105476 | 11.3.0.2824 |
| Community Build 25.3.0.104237 | 11.2.0.2797 |
| Community Build 25.2.0.102705 | 11.1.0.2693 |
| Server 2025.1.0.102418 | 11.1.0.2693 |
| Community Build 25.1.0.102122 | 11.1.0.2693 |
| 10.8.0.100206 | 10.14.0.2599 |
| 10.7.0.96327 | 10.11.0.2468 |
| 10.6.0.92116 | 10.7.0.2191 |
| 10.5.1.90531 | 10.7.0.2191 |
| 10.4.0.87286 | 10.6.0.2114 |
| 10.3.0.82913 | 10.2.0.1908 |
| 10.2.0.77647 | 10.1.0.809 |
| 10.1.0.73491 | 9.17.0.587 |
| 10.0.0.68432 | 9.14.0.375 |
| 9.9.0.65466 | 9.14.0.375 |
| 9.8.0.63668 | 9.13.0.360 |
| 9.7.1.62043 | 9.11.0.290 |
| 9.7.0.61563 | 9.11.0.290 |
| 9.6.1.59531 | 9.9.0.229 |
| 9.6.0.59041 | 9.9.0.229 |
| 9.5.0.56709 | 9.6.1.114 |
| 9.4.0.54424 or earlier | Matches sonarqube version |
### SonarQube Cloud
Current version: 10.14.0.2599
### SonarQube for IDE
| Flavor | Plugin API |
|---------------|--------------|
| Eclipse | 11.4.0.2922 |
| IntelliJ | 11.4.0.2922 |
| Visual Studio | 11.4.0.2922 |
| VSCode | 11.4.0.2922 |
## Optimizing the execution of sensors
See [here](docs/optimize-sensors.md) how to leverage APIs introduced recently to help optimize sensors in order to achieve faster analysis.
## Have Questions or Feedback?
For support questions ("How do I?", "I got this error, why?", ...), please head to the [SonarSource forum](https://community.sonarsource.com/c/help). There are chances that a question similar to yours has already been answered.
Be aware that this forum is a community, so the standard pleasantries ("Hi", "Thanks", ...) are expected. And if you don't get an answer to your thread, you should sit on your hands for at least three days before bumping it. Operators are not standing by. :-)
## License
Copyright 2008-2025 SonarSource.
Licensed under the [GNU Lesser General Public License, Version 3.0](https://www.gnu.org/licenses/lgpl.txt)