TAVERNA-1028 Expose checkstyle.xml in new module
authorStian Soiland-Reyes <stain@apache.org>
Mon, 8 Jan 2018 11:16:38 +0000 (11:16 +0000)
committerStian Soiland-Reyes <stain@apache.org>
Mon, 8 Jan 2018 11:16:38 +0000 (11:16 +0000)
New module: taverna-shared-resources

Also fixes some minor issues in the checkstyle config
as it was outdated.

pom.xml
taverna-shared-resources/pom.xml [new file with mode: 0644]
taverna-shared-resources/src/main/resources/taverna-shared-resources/checkstyle.xml [moved from checkstyle.xml with 96% similarity]

diff --git a/pom.xml b/pom.xml
index 277ccf3..1a17d5c 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -31,7 +31,7 @@
   <version>3-incubating-SNAPSHOT</version>
   <packaging>pom</packaging>
 
-  <name>Apache Taverna (incubating) Maven parent</name>
+  <name>Apache Taverna Maven parent</name>
   <description>
     General POM-file parent for Apache Taverna projects
   </description>
@@ -738,11 +738,29 @@ upgraded - this leads to recursive spaghetti.
           </excludes>
         </configuration>
     </plugin>
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-checkstyle-plugin</artifactId>
+      <!-- NOTE: configuration is under reporting -->
+      <dependencies>
+        <dependency>
+          <!-- contains checkstyle.xml -->
+          <groupId>org.apache.taverna</groupId>
+          <artifactId>taverna-shared-resources</artifactId>
+          <version>3-incubating-SNAPSHOT</version>
+        </dependency>
+      </dependencies>
+    </plugin>    
   </plugins>
 
   <pluginManagement>
     <plugins>
       <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>3.0.0</version>
+      </plugin>
+      <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>
         <version>3.4.0</version>
@@ -781,9 +799,6 @@ upgraded - this leads to recursive spaghetti.
         <artifactId>maven-shade-plugin</artifactId>
         <version>3.1.0</version>
       </plugin>
-
-
-
     </plugins>
   </pluginManagement>
   </build>
@@ -814,11 +829,8 @@ upgraded - this leads to recursive spaghetti.
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
-        <version>2.15</version>
         <configuration>
-          <configLocation>
-            ${basedir}/Rcheckstyle.xml
-          </configLocation>
+          <configLocation>taverna-shared-resources/checkstyle.xml</configLocation>
         </configuration>
       </plugin>
       <plugin>
@@ -903,5 +915,9 @@ upgraded - this leads to recursive spaghetti.
   <distributionManagement>
   </distributionManagement>
        -->
+  <modules>  
+    <module>taverna-shared-resources</module>
+  </modules>
 
 </project>
+
diff --git a/taverna-shared-resources/pom.xml b/taverna-shared-resources/pom.xml
new file mode 100644 (file)
index 0000000..0f297cb
--- /dev/null
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+      <groupId>org.apache.taverna</groupId>
+      <artifactId>apache-taverna-parent</artifactId>
+      <version>3-incubating-SNAPSHOT</version>
+    </parent>
+    <artifactId>taverna-shared-resources</artifactId>
+    <name>Apache Taverna Shared Resources</name>
+    <description>Resources shared across Maven project, e.g. checkstyle config</description>
+</project>
@@ -28,8 +28,8 @@
                </module>
                <module name="JavadocMethod">
                        <property name="scope" value="public"/>
-                       <property name="allowUndeclaredRTE" value="true"/>
                        <property name="severity" value="error"/>
+                       <property name="allowUndeclaredRTE" value="true"/>
                        <property name="allowMissingParamTags" value="true"/>
                        <property name="allowMissingThrowsTags" value="true"/>
                        <property name="allowMissingReturnTag" value="true"/>
                <module name="JavadocType">
                        <property name="scope" value="public"/>
                </module>
+               <module name="JavadocStyle"/>
                <module name="ReturnCount">
                        <property name="severity" value="warning"/>
                </module>
        </module>
-       <module name="PackageHtml"/>
+       <module name="JavadocPackage"/>
 </module>