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.

<table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0zfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=3"></td></tr></table><h2>How to use</h2><p>Just add the following parent declaration in your project parent POM :</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;?xml version="1.0" encoding="UTF-8"?>
&lt;project>
  &lt;modelVersion>4.0.0&lt;/modelVersion>
  &lt;parent>
    &lt;groupId>org.codehaus.sonar-plugins&lt;/groupId>
    &lt;artifactId>parent&lt;/artifactId>
    &lt;version>14&lt;/version>
    &lt;relativePath>../parent&lt;/relativePath>
  &lt;/parent>
  ...
&lt;/project>
</pre></td></tr></table><h2>How to upgrade</h2><p>Just change the version of the parent pom you used previously. Have a look at each release note of each version you upgrade to see if there are some notable changes which require to modify something in your project.</p><h2>How to configure</h2><p>The parent defines and uses a set of custom properties that can be reused and/or overrided by projects to customize the default behavior of maven defined in the parent pom.</p><h3>License</h3><p>Define licenses, inceptionYear and organization :</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;inceptionYear>2010&lt;/inceptionYear>
&lt;organization>
  &lt;name>MyCompany&lt;/name>
  &lt;url>http://mycompany.com&lt;/url>
&lt;/organization>
&lt;licenses>
  &lt;license>
    &lt;name>GNU LGPL v3&lt;/name>
    &lt;url>http://www.gnu.org/licenses/lgpl.txt&lt;/url>
    &lt;distribution>repo&lt;/distribution>
  &lt;/license>
&lt;/licenses>
</pre></td></tr></table><p>You can change values of following properties to control license headers of your source files :</p><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Property</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Default value</p></th></tr><tr><td class="confluenceTd"><p>license.name</p></td><td class="confluenceTd"><p>Possible values are : &quot;GNU LGPL 3&quot;, &quot;AL2&quot;, &quot;MIT&quot;.</p></td><td class="confluenceTd"><p>GNU LGPL 3</p></td></tr><tr><td class="confluenceTd"><p>license.title</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>${project.name}</p></td></tr><tr><td class="confluenceTd"><p>license.year</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>${project.inceptionYear}</p></td></tr><tr><td class="confluenceTd"><p>license.owner</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>${project.organization.name}</p></td></tr><tr><td class="confluenceTd"><p>license.mailto</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>dev@sonar.codehaus.org</p></td></tr></tbody></table><p>Now you can add/update headers of your source files using following command :</p><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>mvn license:format</pre></td></tr></table><h3>Maven plugins versions</h3><p>The parent pom defines in a set of properties all recommended versions of maven plugins to use.</p><table class="wysiwyg-macro" data-macro-name="note" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vdGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>This isn't recommended but could be useful to use a new version of a plugin not yet available in the parent POM or to workaround a bug by using another version. In all cases don not forget <a href="http://jira.codehaus.org/browse/SONARPLUGINS/component/14384">to report to us</a> the change you need. If it's good for one project, it could be useful for others.</p></td></tr></table><p>Each project/module can override a version of a plugin to use a different from the one defined in parent. For example to change version of sonar-packaging-maven-plugin you can use following code snippet:</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;properties>
  &lt;version.sonar-packaging.plugin>1.2&lt;/version.sonar-packaging.plugin>
&lt;/properties>
</pre></td></tr></table><h3>Profiles</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Name</th><th class="confluenceTh">Identifier</th><th class="confluenceTh">Activation</th><th class="confluenceTh">Description</th></tr><tr><td class="confluenceTd">Release profile</td><td class="confluenceTd">release</td><td class="confluenceTd">Deactivated by default. Activated during release. Can be activated with -Prelease</td><td class="confluenceTd">Generates javadoc artifacts.</td></tr><tr><td class="confluenceTd">Integration tests</td><td class="confluenceTd">integration-tests</td><td class="confluenceTd">Deactivated by default. Can be activated with -Pintegration-tests</td><td class="confluenceTd">Launch integration tests from JUnit using the <a href="http://maven.apache.org/plugins/maven-failsafe-plugin/">failsafe plugin</a>.</td></tr></tbody></table><h2>Known problems</h2><p>Deployment not possible if you are behind proxy - see <a href="https://jira.codehaus.org/browse/SONARPLUGINS-1457">SONARPLUGINS-1457</a></p><h2>Development</h2><p>All plugins specified in POM, must be compatible with &quot;maven.min.version&quot; and &quot;java.min.version&quot;. This and available plugins updates can be checked with help of <a href="http://mojo.codehaus.org/versions-maven-plugin/">versions-maven-plugin</a>.</p><h2>Changelog</h2><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxNHxoZWlnaHQ9MTIwfHJlbmRlck1vZGU9c3RhdGljfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eTtzdGF0dXM7cmVzb2x1dGlvbnx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODU0MiZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=120|renderMode=static|title=Version 14|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18542&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxM3xoZWlnaHQ9MTIwfHJlbmRlck1vZGU9c3RhdGljfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eTtzdGF0dXM7cmVzb2x1dGlvbnx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODQxOSZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=120|renderMode=static|title=Version 13|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18419&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxMnxoZWlnaHQ9MTIwfHJlbmRlck1vZGU9c3RhdGljfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eTtzdGF0dXM7cmVzb2x1dGlvbnx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODM2NCZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=120|renderMode=static|title=Version 12|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18364&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxMXxoZWlnaHQ9MTIwfHJlbmRlck1vZGU9c3RhdGljfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eTtzdGF0dXM7cmVzb2x1dGlvbnx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2pxbFF1ZXJ5PXByb2plY3QrJTNEK1NPTkFSUExVR0lOUytBTkQrZml4VmVyc2lvbislM0QrUEFSRU5ULTExK0FORCtzdGF0dXMrJTNEK0Nsb3NlZCtPUkRFUitCWStwcmlvcml0eStERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=120|renderMode=static|title=Version 11|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery\=project+%3D+SONARPLUGINS+AND+fixVersion+%3D+PARENT-11+AND+status+%3D+Closed+ORDER+BY+priority+DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxMHxoZWlnaHQ9MTIwfHJlbmRlck1vZGU9c3RhdGljfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eTtzdGF0dXM7cmVzb2x1dGlvbnx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNzM2MyZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=120|renderMode=static|title=Version 10|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17363&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiA5fGhlaWdodD0xMjB8cmVuZGVyTW9kZT1zdGF0aWN8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5O3N0YXR1cztyZXNvbHV0aW9ufHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE3MDQxJnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=120|renderMode=static|title=Version 9|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17041&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiA4fGhlaWdodD0xODB8cmVuZGVyTW9kZT1zdGF0aWN8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5O3N0YXR1cztyZXNvbHV0aW9ufHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2OTI1JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=180|renderMode=static|title=Version 8|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16925&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiA3fGhlaWdodD0zMDB8cmVuZGVyTW9kZT1zdGF0aWN8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5O3N0YXR1cztyZXNvbHV0aW9ufHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2NzY4JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status;resolution|height=300|renderMode=static|title=Version 7|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16768&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000"></p>