Uploaded image for project: 'Apache Taverna'
  1. Apache Taverna
  2. TAVERNA-1028

Make checkstyle.xml accessible in other projects

    Details

    • Type: Bug
    • Status: Done
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: parent 2
    • Fix Version/s: parent 3
    • Component/s: Taverna Maven Parent
    • Labels:
      None

      Description

      Taverna Maven Parent includes a checkstyle.xml for the maven-checkstyle-plugin - which is configured as part of the Maven Site for Taverna Server.

      However as checkstyle.xml is just in the root of the git repository, and taverna-maven-parent is of type pom, the file is not available in other projects and would have to be manually copied. Also the current config

      <configLocation>${basedir}/Rcheckstyle.xml</configLocation>
      

      will be wrong (not just because of the spurious R) as ${basedir} is local to each module when building the site.

      The suggestion is to create a multimodule configuration as recommended by the plugin: https://maven.apache.org/plugins/maven-checkstyle-plugin/examples/multi-module-config.html

      So I'm making taverna-shared-resources/src/main/resources/taverna-shared-resources/checkstyle.xml and updating the checkstyle file slightly.

      BTW, here's the example of a more complete checkstyle file we in theory could use instead from the dependency maven-shared-resources - but I think it would raise too many warnings for our varied codebase.

      https://maven.apache.org/shared/maven-shared-resources/maven_checks.html

      (BTW - my suggestion is not to enable checkstyle enforcement at this point, just to make the config work again so the report can be generated)

        Attachments

          Activity

            People

            • Assignee:
              stain Stian Soiland-Reyes
              Reporter:
              stain Stian Soiland-Reyes
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: