Uploaded image for project: 'JBoss Developer Materials'
  1. JBoss Developer Materials
  2. JDF-209

Build a Quickstarts verification tool

    XMLWordPrintable

Details

    • Feature Request
    • Resolution: Done
    • Major
    • None
    • None
    • None
    • None

    Description

      Some requirements:

      • Validating quickstart POM files:
        • OK Check for the License header (checkstyle headers) - OK Headers templates must be updated: https://github.com/jboss/ide-config/pull/6
        • OK Check for proper spacing and Indentation (try checkstyle - whitespace rule and indentation rule)
        • OK Check and verify if all quickstarts are using the same/latest BOM versions
        • OK Verify is it using the standard properties names (We will provide the standard properties name)
        • OK Check for non bom versions (and identify if we should create a new BOM)
        • Check javascript and css versions
        • OK Check for duplicate properties and dependencies
        • OK Check for unused properties on project and its modules
        • OK Check the pom.xml elements order
        • Create scripts to update versions (quickstart, boms, etc)
        • OK When a new quickstart is added, if it has a pom.xml file, make sure the <module> is defined in one of the following profiles: default, requires-postgres, complex-dependencies, requires-full, requires-xts, non-maven.
        • OK Check if all dependencies are in central (the issue that was discussed in JDF-206).
        • OK Check for a `<finalName>${project.artifactId}</finalName>` in the file to prevent appending version numbers to archives.
        • OK Check for the apache license
        • OK Check if project groupId is 'org.jboss.as.quickstarts'
      • Validating quickstart README files:
        • OK Check for the required metadata tags in README (Level, Author, Target Product, etc)
        • OK Verify the quickstart name in the README matches the folder name and the project name
      • Validating quickstart source code
        • Check the quantity of comments in the code (evaluate PMD)
      • General validation (desired):
        • If a quickstart with a source other than the current repository is modified, create an alert of some sort so we can notify the upstream repository of the change.
        • When we update a BOM property version in the quickstarts, we need to make the same changes in the archetypes.
        • Also, if there is a code fix in the kitchensink or kitchensink-ear, we need to make the same fix in the archetype code and check other quickstarts based on the same archetype to see if they need the fixes applied.

      Attachments

        Issue Links

          Activity

            People

              rafabene_jira Rafael Benevides (Inactive)
              rafabene_jira Rafael Benevides (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: