Kuali Rice Development
  1. Kuali Rice Development
  2. KULRICE-3217

Update Rice packaging process and related documentation for 1.0, practice generating packaged artifacts

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0
    • Component/s: Packaging
    • Labels:
      None
    • Similar issues:
      KULRICE-3413Add dataset packaging to the Rice packaging scripts
      KULRICE-4887Update package naming standards document
      KULRICE-7793DB Update: DataDictionaryQualifierResolver class package was not updated in Rice 2.0 upgrade scripts
      KULRICE-7781DataDictionaryQualifierResolver class package was not updated in Rice 2.0 upgrade scripts
      KULRICE-2061Merge 0.9.2.1 Packaging work into 0.9.3
      KULRICE-5235Package 1.0.3.2 release
      KULRICE-1712Refactor Package Names of Rice Modules
      KULRICE-4275Determine how best to position and package the cornell pdf enhancement
      KULRICE-1442Develop and document a package naming standard for Rice modules
      KULRICE-3675Execute final packaging and deployment of Rice 1.0.1

      Description

      There are ant scripts that already exist for packaging in the rice project but they need to be updated. Packaging includes:

      1) Generating source distrubution
      2) Generating binary distribution
      3) Generating WAR distribution
      4) Deployment jars and war to maven repository
      5) Deploying maven site (specifically for javadocs)]
      6) Ensuring packages have proper licensing and acknowledgements
      7) Authoring of release notes and upgrade process for 0.9.3 to 1.0

      An import new twist on our packaging this release is the fact that we will need to include our impex datasets in our binary and war releases (or make the datasets available for download seperately). We may need to scrub the db for bootstrap release and we'll definately want to use the tasks built into impex for packaging.

      We will also want to look at getting our downloads up on www.kuali.org like the KC and KFS downloads are.

      Once we have some sample distro packages in place, will want to send those to innovativ to make sure we get any relevant install guide documentation updated.

        Activity

        Hide
        Eric Westfall added a comment -

        Included Farooq as a watcher on this for the last part of this issue regarding getting our downloads up at kuali.org. What do we need to do to make this happen?

        Show
        Eric Westfall added a comment - Included Farooq as a watcher on this for the last part of this issue regarding getting our downloads up at kuali.org. What do we need to do to make this happen?
        Hide
        Eric Westfall added a comment -

        Casey, here is a link to the old confluence page on the Rice distributions.

        https://test.kuali.org/confluence/display/KRDOC/Rice+Distributions+(0.9.3)

        Show
        Eric Westfall added a comment - Casey, here is a link to the old confluence page on the Rice distributions. https://test.kuali.org/confluence/display/KRDOC/Rice+Distributions+(0.9.3 )
        Hide
        Eric Westfall added a comment -

        In addition to what's listed in this document:

        1) Instead of a .war file for the standalone deliverable, i think it would be good to have a .zip file that has the war in it. And then we can include a licenses directory.
        2) The other important thing to do will be to include the impex tool in the binary and standalone release along with our datasets. There's a target in the impex tool that packages it up for distributions (and for packing datasets). We can look at KFS release 2.2 for an example of how they did this.

        Show
        Eric Westfall added a comment - In addition to what's listed in this document: 1) Instead of a .war file for the standalone deliverable, i think it would be good to have a .zip file that has the war in it. And then we can include a licenses directory. 2) The other important thing to do will be to include the impex tool in the binary and standalone release along with our datasets. There's a target in the impex tool that packages it up for distributions (and for packing datasets). We can look at KFS release 2.2 for an example of how they did this.
        Hide
        Casey Boettcher (Inactive) added a comment -

        while checking the dist-src target, I discovered that there are 27 empty directories in the project. Unless you have objections, I'll eliminate them. Here they are:

        ./dist-src/rice-1.0.0-SNAPSHOT-src/api/src/main/java/org/kuali/rice/kim/bo/role/impl
        ./dist-src/rice-1.0.0-SNAPSHOT-src/api/src/main/java/org/kuali/rice/kim/service/support/impl
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/config/ddl
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kew/core
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kim/bo/reference/dto
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kim/dao/proxy
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kim/service/translators
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/ksb/ojb
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kew/resources
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kim/bo/entity
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kim/bo/group
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kim/service
        ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/test/java/org/kuali/rice/kim/service/impl
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kcb/src/test/resources/org/kuali/rice/kcb/config
        ./dist-src/rice-1.0.0-SNAPSHOT-src/ken/src/test/resources/org/kuali/rice/ken/config
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kew/src/test/java/org/kuali/rice/kew/actionlist/web
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/baseline
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/inquirable
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/kns/authorization
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/kns/datadictionary/exporter
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/transactiondocument
        ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/web
        ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/config/standalone-config/WEB-INF/classes
        ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/java/org/kuali/rice
        ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/webapp/en
        ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/webapp/kew/WEB-INF/jsp/backdoor
        ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/webapp/kim/WEB-INF/tag

        Show
        Casey Boettcher (Inactive) added a comment - while checking the dist-src target, I discovered that there are 27 empty directories in the project. Unless you have objections, I'll eliminate them. Here they are: ./dist-src/rice-1.0.0-SNAPSHOT-src/api/src/main/java/org/kuali/rice/kim/bo/role/impl ./dist-src/rice-1.0.0-SNAPSHOT-src/api/src/main/java/org/kuali/rice/kim/service/support/impl ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/config/ddl ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kew/core ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kim/bo/reference/dto ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kim/dao/proxy ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/kim/service/translators ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/java/org/kuali/rice/ksb/ojb ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kew/resources ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kim/bo/entity ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kim/bo/group ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/main/resources/org/kuali/rice/kim/service ./dist-src/rice-1.0.0-SNAPSHOT-src/impl/src/test/java/org/kuali/rice/kim/service/impl ./dist-src/rice-1.0.0-SNAPSHOT-src/kcb/src/test/resources/org/kuali/rice/kcb/config ./dist-src/rice-1.0.0-SNAPSHOT-src/ken/src/test/resources/org/kuali/rice/ken/config ./dist-src/rice-1.0.0-SNAPSHOT-src/kew/src/test/java/org/kuali/rice/kew/actionlist/web ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/baseline ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/inquirable ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/kns/authorization ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/kns/datadictionary/exporter ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/transactiondocument ./dist-src/rice-1.0.0-SNAPSHOT-src/kns/src/test/java/org/kuali/rice/web ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/config/standalone-config/WEB-INF/classes ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/java/org/kuali/rice ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/webapp/en ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/webapp/kew/WEB-INF/jsp/backdoor ./dist-src/rice-1.0.0-SNAPSHOT-src/web/src/main/webapp/kim/WEB-INF/tag
        Hide
        Eric Westfall added a comment -

        If their empty then I say go ahead and delete them.

        Show
        Eric Westfall added a comment - If their empty then I say go ahead and delete them.
        Hide
        Casey Boettcher (Inactive) added a comment - - edited

        The dist-binary target is broken. It relies upon the creation of a "server" directory and the installation of a server jar in the repository, but neither is accomplished by the target it depends upon, install-rice-jars.

        Ant is angry b/c server/src/main/webapp directory does not exist, nor does the target it's supposed to be copying into, target/ant-build/dist-binary-rice-<version>-bin/webcontent.

        The solution was to add a newly created target (maven-install-server-jar) to the list of dependency targets for dist-binary and alter the name of the directory that's copied into webcontent.

        Also, the dependencies are not being packaged with the rice jars. I've attached a full diff of the exploded archives of 0.93 distro and the current rice 1.0.0 branch.

        Show
        Casey Boettcher (Inactive) added a comment - - edited The dist-binary target is broken. It relies upon the creation of a "server" directory and the installation of a server jar in the repository, but neither is accomplished by the target it depends upon, install-rice-jars. Ant is angry b/c server/src/main/webapp directory does not exist, nor does the target it's supposed to be copying into, target/ant-build/dist-binary-rice-<version>-bin/webcontent. The solution was to add a newly created target (maven-install-server-jar) to the list of dependency targets for dist-binary and alter the name of the directory that's copied into webcontent. Also, the dependencies are not being packaged with the rice jars. I've attached a full diff of the exploded archives of 0.93 distro and the current rice 1.0.0 branch.
        Hide
        Eric Westfall added a comment -

        Casey, i think this is done now. You've logged KRDOC jiras for the documentation related to this. I'm going to resolve, let me know if there are additional tasks we need to log in jira related to this. Thanks.

        Show
        Eric Westfall added a comment - Casey, i think this is done now. You've logged KRDOC jiras for the documentation related to this. I'm going to resolve, let me know if there are additional tasks we need to log in jira related to this. Thanks.
        Hide
        Eric Westfall added a comment -

        Bulk change of all Rice 1.0 issues to closed after public release.

        Show
        Eric Westfall added a comment - Bulk change of all Rice 1.0 issues to closed after public release.

          People

          • Assignee:
            Casey Boettcher (Inactive)
            Reporter:
            Eric Westfall
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Structure Helper Panel