Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 65 Next »

Tempted to go ahead and write your own plugin? No obligation, but you might want to share it with the Sonar community. In that case hosting your plugin at sonar-plugins.codehaus.org brings you many benefits :

  • The community helps you more easily, as well as the community benefits from the plugin
  • Hosting in the Github organization named SonarCommunity
  • Use JIRA to track issues
  • Use Atlassian Bamboo for continuous integration
  • Use this wiki for the documentation
  • Most of all the plugin is available in Update Center, so users can install the plugin directly from the application

If you do decide to contribute your plugin back to the community, we're 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. But there are a few rules we must ask you to follow.

To have your plugin added to the forge, it must:

  • 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.

Request Hosting

  1. Create an account at Codehaus
  2. Subscribe to dev@sonar.codehaus.org
  3. Send e-mail to dev@sonar.codehaus.org and tell us your Codehaus ID, so that we can give you a commit access to github. You can request access rights to Nemo too.

Prerequisites

  • 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.

Principles

When you utilize the forge, we request that you respect the following principles :

  1. Follow Best practices and Sonar Code Style.
  2. The copyright belongs to whoever wrote the plugin
  3. The license must be business friendly
  4. Follow the release process described bellow.

Maven POM

  • 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 "sonar-foo-plugin"
  • Set the following properties :

    pom.xml
  • Configure your pom by overriding values provided by parent - see Sonar Plugins Forge Parent POM. Default license is LGPL3.
  • Follow Maven POM Code Convention
  • Add the plugin to the main pom of the forge

Continuous Integration

Please send an email to the dev mailing list in order the plugin to be added to our Continuous Integration server.

How to Release

The release process is explained in this page.

  • No labels