Uploaded image for project: 'Maven Site Plugin'
  1. Maven Site Plugin
  2. MSITE-453

Add new lifecycle bindings for "maven-skin" packaging

    XMLWordPrintableJSON

Details

    • New Feature
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • None
    • backlog, wontfix-candidate
    • None
    • None
    • Patch

    Description

      Currently, creating a custom skin for Maven is done by a project with packaging "jar". The attached patch intents to introduce an individual lifecycle mapping named "maven-skin" for this purpose.

      Why that? I consider the re-usage of the "jar" packaging an abuse for the case of building a Maven skin. On the one hand, the "jar" packaging does too much. Skins usually do not get compiled or unit-tested, do they? Since any unused plugin invocation is an unnecessary risk of a build failure (sorry to say), I would appreciate a lifecycle mapping that is not overdressed. On the other hand, I could image that skins required some additional processing some day like a check whether all required images are present in the skin or whether the CSS references unknown IDs/names. Having a distinct lifecylcle mapping in the Maven Core would allow for a central definition of the build steps instead of requiring all users to extend the "jar" packaging.

      Especially for the first reason, i.e. having a packaging that does not more than required, the patch also defines a "resources" packaging. Such a packaging is intended for JARs that just contain resources one wants to share with other projects like rulesets for PMD, Checkstyle, etc. The lifecylcle mappings "resources" and "maven-skin" are identiical (now) but I consider it a bad practice to merge different use-cases just because they happen to be equal by coindicence.

      Attachments

        1. new-lifecycle-mappings.patch
          3 kB
          Benjamin Bentmann

        Issue Links

          is depended upon by

          Improvement - An improvement or enhancement to an existing feature or task. DOXIASITETOOLS-88 normalize newlines of text resources copied from skin

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. MNG-1683 type zip for packaging ?

          • Major - Major loss of function.
          • Reopened
          relates to

          New Feature - A new feature of the product, which has yet to be developed. DOXIASITETOOLS-149 Create a skin descriptor to contain metadata about the skin

          • Major - Major loss of function.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. MSITE-121 Generated html files contain inconsistent new lines

          • Major - Major loss of function.
          • Closed

          Activity

            People

              Unassigned Unassigned
              bentmann Benjamin Bentmann
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated: