Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>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 <a href="http://sonar-plugins.codehaus.org">sonar-plugins.codehaus.org</a> brings you many benefits :</p><ul><li>The community helps you more easily, as well as the community benefits from the plugin</li><li>Hosting in the Github organization named <a href="https://github.com/sonarcommunity/">SonarCommunity</a></li><li>Use <a href="http://jira.codehaus.org/browse/SONARPLUGINS">JIRA</a> to track issues</li><li>Use Atlassian Bamboo for <a href="http://bamboo.ci.codehaus.org/browse/SONAR">continuous integration</a></li><li>Use this wiki for the documentation</li><li><strong>Most of all the plugin is available in Update Center</strong>, so users can install the plugin directly from the application</li></ul><h1>Request Hosting</h1><ol><li>Create an account at <a href="http://xircles.codehaus.org">Codehaus</a></li><li><a href="http://xircles.codehaus.org/lists/dev@sonar.codehaus.org">Subscribe</a> to dev@sonar.codehaus.org</li><li>Send e-mail to <a href="mailto:dev@sonar.codehaus.org">dev@sonar.codehaus.org</a> and tell us your Codehaus ID, so that we can give you a commit access to <a href="https://github.com/SonarCommunity">github</a>. You can request access rights to <a href="http://nemo.sonarsource.org/dashboard/index/org.codehaus.sonar-plugins:all">Nemo</a> too.</li></ol><h1>Prerequisites</h1><ul><li>The plugin <strong>must support </strong><s><strong>Java 5</strong></s> (<strong>Java 6</strong> since March 2013). The Continuous Integration job uses Oracle JDK 6.</li><li>The plugin is built with Maven 2.2.x or 3.x.</li></ul><h1>Principles</h1><p>When you utilize the forge, we request that you respect the following principles :</p><ol><li>Follow <a class="confluence-link" href="/display/SONAR/Developer+Guide#DeveloperGuide-Bestpractices" data-anchor="Best practices" data-linked-resource-id="87720120" data-linked-resource-type="page" data-linked-resource-default-alias="Developer Guide#Best practices" data-base-url="http://docs.codehaus.org">Best practices</a> and <a class="confluence-link" href="/display/SONAR/Developer+Guide#DeveloperGuide-Codeformatting" data-anchor="Code formatting" data-linked-resource-id="87720120" data-linked-resource-type="page" data-linked-resource-default-alias="Developer Guide#Code formatting" data-base-url="http://docs.codehaus.org">Sonar Code Style</a>.</li><li>The copyright belongs to whoever wrote the plugin</li><li>The license must be <a href="http://codehaus.org/customs/licenses.html">business friendly</a></li><li>Follow the release process described bellow.</li></ol><h1>Maven POM</h1><ul><li>The directory name is the plugin name.</li><li>The groupId is '<strong>org.codehaus.sonar-plugins</strong>' and artifactId is 'sonar-&lt;name&gt;-plugin'. For example the plugin &quot;foo&quot; is stored in the directory &quot;foo&quot; and its artifact id is &quot;sonar-foo-plugin&quot;</li><li><p>Set the following properties :</p><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="lang=xml|title=pom.xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9cG9tLnhtbHxsYW5nPXhtbH0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;project>
  &lt;parent>
    &lt;groupId>org.codehaus.sonar-plugins&lt;/groupId>
    &lt;artifactId>parent&lt;/artifactId>
    &lt;!-- 
         The latest version can be found by looking at the tags starting with "parent-" 
         in http://svn.codehaus.org/sonar-plugins/tags/
    -->
    &lt;version>REPLACE_BY_LATEST_VERSION&lt;/version>
    &lt;relativePath>../parent&lt;/relativePath>
  &lt;/parent>
  &lt;artifactId>sonar-foo-plugin&lt;/artifactId>
  &lt;version>1.0-SNAPSHOT&lt;/version>
  &lt;packaging>sonar-plugin&lt;/packaging>
  &lt;name>Plugin name&lt;/name>
  &lt;description>Plugin description&lt;/description>
  &lt;url>http://docs.codehaus.org/display/SONAR/MY+PLUGIN&lt;/url>
  &lt;inceptionYear>2013&lt;/inceptionYear>
  &lt;organization>
    &lt;name>My Organization&lt;/name>
    &lt;url>http://www.my-organization.com&lt;/url>
  &lt;/organization>
  &lt;issueManagement>
    &lt;system>JIRA&lt;/system>
    &lt;url>http://jira.codehaus.org/browse/SONARPLUGINS/component/MY-COMPONENT-ID&lt;/url>
  &lt;/issueManagement>
  &lt;scm>
    &lt;connection>scm:svn:http://svn.codehaus.org/sonar-plugins/trunk/MY-PLUGIN&lt;/connection>
    &lt;developerConnection>scm:svn:https://svn.codehaus.org/sonar-plugins/trunk/MY-PLUGIN&lt;/developerConnection>
    &lt;url>http://svn.sonar-plugins.codehaus.org&lt;/url>
  &lt;/scm>
  ...
&lt;/project>
</pre></td></tr></table></li><li>Configure your pom by overriding values provided by parent - see <a class="confluence-link" href="/display/SONAR/Sonar+Plugins+Forge+Parent+POM" data-linked-resource-id="185073714" data-linked-resource-type="page" data-linked-resource-default-alias="Sonar Plugins Forge Parent POM" data-base-url="http://docs.codehaus.org">Sonar Plugins Forge Parent POM</a>. Default license is LGPL3.</li><li>Follow <a href="http://maven.apache.org/developers/conventions/code.html#POM_Code_Convention">Maven POM Code Convention</a></li><li>Add the plugin to the <a href="http://svn.codehaus.org/sonar-plugins/trunk/pom.xml">main pom</a> of the forge</li></ul><h1>Continuous Integration</h1><p>Please send an email to the dev mailing list in order the plugin to be added to our <a href="http://bamboo.ci.codehaus.org/browse/SONAR">Continuous Integration server</a>.</p><h1>How to Release</h1><p>The release process is <a class="confluence-link" href="/display/SONAR/Releasing+a+Plugin" data-linked-resource-id="120258992" data-linked-resource-type="page" data-linked-resource-default-alias="Releasing a Plugin" data-base-url="http://docs.codehaus.org">explained in this page</a>.</p>