Spring Framework
  1. Spring Framework
  2. SPR-3198

Create javadoc and source jars for seperate modules (Maven friendliness)

    Details

    • Type: Task Task
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Duplicate
    • Affects Version/s: 2.0.2
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Last commented by a User:
      false

      Description

      Note: There are a number of already existing related issues, but none seemed to address this one specific improvement: create companion javadoc and source archives for every spring jar, including module jars, and make them available via maven.

      One of the benefits to using maven is the automatic downloading and configuration of source and javadoc for a specific library. This can be done directly from maven (e.g. mvn idea:idea or mvn eclipse:eclipse) or through an IDE plugin (e.g. Maven Reloaded). When it works, it's really quite nice and brings us a step closer to an ideal development environment.

      Currently, the javadoc and source archives are created and made available only for the mondo, all-encompassing spring.jar. In this case, auto-fetching and configuration of source and javadoc works great. One could even say it works awesome.

      Unfortunately, we're only using a subset of spring and we explicitly list our dependencies on each module. In this case, there aren't any javadoc or source modules to be associated with the class jars. It would be fantastic if spring also provided these for those of us who only require a small subset of spring and would like to leverage maven's ability to auto-fetch and configure these.

      With future versions of spring, is it possible to include the associated javadoc and source archies for all of the spring jars, including the seperate module jars?

      Christian

        Issue Links

          Activity

          Hide
          Tomasz Blachowicz added a comment -

          I think Christian is right, I'd be handy to have javadocs and sources boundled with jar files available in Maven central repository.

          I'd like to take a look a that. Can you just answer a quick question? How do you create bundle for central repository at the moment? Is there any script or other automated way of doing that? I just don't want to reinvent the wheel

          Show
          Tomasz Blachowicz added a comment - I think Christian is right, I'd be handy to have javadocs and sources boundled with jar files available in Maven central repository. I'd like to take a look a that. Can you just answer a quick question? How do you create bundle for central repository at the moment? Is there any script or other automated way of doing that? I just don't want to reinvent the wheel
          Hide
          Paul Benedict added a comment -

          The Maven super POM has a built-in profile which allow the automatic packaging of sources and javadocs. Activate it with parameter -DperformRelease=true

          Show
          Paul Benedict added a comment - The Maven super POM has a built-in profile which allow the automatic packaging of sources and javadocs. Activate it with parameter -DperformRelease=true
          Hide
          nebhale added a comment -

          We don't use maven for our build system, so it's going to take more than just that. Thanks for the input though.

          Show
          nebhale added a comment - We don't use maven for our build system, so it's going to take more than just that. Thanks for the input though.
          Hide
          Jasper Rosenberg added a comment -

          This would be very handy. In particular, it would be nice to have for the spring-mock artifact as we do use the "spring" artifact which does have sources, but of course does not include the indepenently declared spring-mock testing classes/sources (in other words, no workaround).

          Show
          Jasper Rosenberg added a comment - This would be very handy. In particular, it would be nice to have for the spring-mock artifact as we do use the "spring" artifact which does have sources, but of course does not include the indepenently declared spring-mock testing classes/sources (in other words, no workaround).
          Hide
          Greg Wiley added a comment -

          In case this helps:

          Every time we update the Spring version in our POMs, I run through the spring module directories in .m2 and copy the full Spring source jar, appropriately renamed, into it. mvn eclipse:eclipse then happily attaches the sources.

          So, I think one possible solution would be to simply include the full Spring source jar, renamed appropriately, in each module directory on the central repo.

          -dub

          Show
          Greg Wiley added a comment - In case this helps: Every time we update the Spring version in our POMs, I run through the spring module directories in .m2 and copy the full Spring source jar, appropriately renamed, into it. mvn eclipse:eclipse then happily attaches the sources. So, I think one possible solution would be to simply include the full Spring source jar, renamed appropriately, in each module directory on the central repo. -dub
          Hide
          nebhale added a comment -

          We'll get this done, I promise. It's on the list and pretty high priority, I just have to get the time when we're not right up against a release.

          Show
          nebhale added a comment - We'll get this done, I promise. It's on the list and pretty high priority, I just have to get the time when we're not right up against a release.
          Hide
          nebhale added a comment -

          Track SPR-2704 for progress on this issue

          Show
          nebhale added a comment - Track SPR-2704 for progress on this issue

            People

            • Assignee:
              nebhale
              Reporter:
              Christian Nelson
              Last updater:
              Trevor Marshall
            • Votes:
              9 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Days since last comment:
                6 years, 47 weeks, 6 days ago