Tempted to go ahead and write your own plugin? Want to contribute your plugin back to the community? If you do, we'd be happy to host your FOSS plugins in the SonarSource plugin forge. After all, it gives you a broader audience and enhances the community. Everyone’s a winner. Plus:
- It's easier for the community to help you
- Source code is hosted in the Github organization named SonarCommunity
- Use JIRA to track issues
- Use Jenkins for continuous integration
- Use this wiki for documentation
- Most of all, the plugin is available in the Update Center, so users can quickly install the plugin from the SonarQube web interface
- meet our coding standards
- not be misleading in terms of content (the code needs to do pretty much what the name and description say it does)
- have a business-friendly license (the default license is LGPL3)
- not compete with existing SonarSource products (sorry, but we gotta pay the bills somehow)
- receive +1’s from three voting members of the development list and no -1’s for the initial release
To keep your plugin in the forge, it must remain in compliance with everything on the first list and:
be maintained over time (meaning you should pay attention to the mailing lists and respond to bugs and API changes)
receive at least one +1 from a voting member of the development mailing list for subsequent releases
If any of these requirements are not met, or stop being met (if, for example you change the license to one that’s not business-friendly) we may remove the plugin from the forge immediately
Sharing an existing plugin
Code Your Plugin
- The plugin must support
Java 5(Java 6 since March 2013). The Continuous Integration job uses Oracle JDK 6.
- The plugin is built with Maven 2.2.x or 3.x
When you utilize the forge, we request that you respect the following principles :
- The copyright belongs to whoever wrote the plugin
- Follow the release process described bellow
- The directory name is the plugin name
- The groupId is '
org.codehaus.sonar-plugins' and artifactId is '
sonar-<name>-plugin'. For example the plugin "foo" is stored in the directory "foo" and its artifact id is "
Set the following properties:
Code Block title pom.xml lang xml
<project> <parent> <groupId>org.codehaus.sonar-plugins</groupId> <artifactId>parent</artifactId> <!-- The latest version can be found by looking at the tags starting with "parent-" in http://svn.codehaus.org/sonar-plugins/tags/ --> <version>REPLACE_BY_LATEST_VERSION</version> <relativePath>../parent</relativePath> </parent> <artifactId>sonar-foo-plugin</artifactId> <version>1.0-SNAPSHOT</version> <packaging>sonar-plugin</packaging> <name>Plugin name</name> <description>Plugin description</description> <url>http://docs.codehaus.org/display/SONAR/MY+PLUGIN</url> <inceptionYear>2013</inceptionYear> <organization> <name>My Organization</name> <url>http://www.my-organization.com</url> </organization> <issueManagement> <system>JIRA</system> <url>http://jira.codehaus.org/browse/SONARPLUGINS/component/MY-COMPONENT-ID</url> </issueManagement> <scm> <connection>scm:svn:http://svn.codehaus.org/sonar-plugins/trunk/MY-PLUGIN</connection> <developerConnection>scm:svn:https://svn.codehaus.org/sonar-plugins/trunk/MY-PLUGIN</developerConnection> <url>http://svn.sonar-plugins.codehaus.org</url> </scm> ... </project>
- Configure your pom by overriding values provided by parent - see SonarQube Plugins Forge Parent POM. Default license is LGPL3.
- Follow Maven POM Code Convention
- Add the plugin to the main pom of the forge
Please send Send an email to the dev mailing list in order the plugin to be added to our Continuous Integration server.
Release Your Plugin
The release process is explained in this page.