Directives

Table of Contents universAAL Code Directives POM constrains SVN Constrains Naming Other Checks

universAAL Code Directives

These directives are an automatically testable set of requirements imposed by D2.3. A Maven plugin is being developed to check the compliance of the code with these directives.

Checkout the plugin documentation for deatils on how to use the plugin.

POM constrains

Dependency Management

This directive will check that the dependency management section of a root pom is correct. Meaning all the declared modules are also included as a managed dependency, and that the version of such dependency is correct.

Versioning

This procedures will help increase the version of any artifact. Compling also with tagging policy, if used, it will automatically tag the current version before changing the version.

SCM Properties

This Directive Will check that there is a gforge.project.name property defined, specially useful for root POMs.

SVN Constrains

SCM POM sync

This Directive Will check that the SCM section in the POM points to the correct SVN URL (obtained from the working directory metadata).

SVN Ignores

This Directive will check that the SVN repository is ignoring the files it has to ignore (".settings", ".classpath", ".project", and "target").

Tagging Policy

This procedure will perform a tag in compliance with tagging policy, according to the current atifact's version (SNAPSHOT or RELEASE).

Naming

Container Decoupling

This Directive will check that there are no dependencies and or imports of OSGi container framework Classes.

Maven Coordintaes

This Directive will check that the maven coordinates (groupId, artifactId and version) along with the name follow a convention dictated for all artifacts within the same Expert Group.

Other Checks

Licensing

(TBD) This Directive will check that there is a license on all files and that the required "LICENCE.txt" and "NOTICE.txt" exists. I may also check the POM licence section is consistent with headers and files.