Details

    • Type: Sub-task Sub-task
    • Status: Resolved
    • Priority: Blocker Blocker
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.1.0
    • Component/s: documentation
    • Labels:
      None
    1. WHIRR-77.patch
      15 kB
      Tom White
    2. WHIRR-77.patch
      48 kB
      Tom White
    3. WHIRR-77.patch
      55 kB
      Tom White
    4. WHIRR-77.patch
      36 kB
      Tom White

      Activity

      Hide
      Tom White added a comment -

      The javadoc is built if you do "mvn site -Pjavadoc" (arguably we should get "mvn site" to just work, the reason javadoc was put in a profile was to save time when building jars, since javadoc jars are built too).

      I've just committed this.

      Show
      Tom White added a comment - The javadoc is built if you do "mvn site -Pjavadoc" (arguably we should get "mvn site" to just work, the reason javadoc was put in a profile was to save time when building jars, since javadoc jars are built too). I've just committed this.
      Hide
      Patrick Hunt added a comment -

      +1, looks good to me. RAT is clean. I ran install and also built the "mvn site", both of which were successful.

      The javadoc api link is 404 though, I don't see this on the howtorelease. Is it a manual step or is it not being triggered as part of the build?

      Show
      Patrick Hunt added a comment - +1, looks good to me. RAT is clean. I ran install and also built the "mvn site", both of which were successful. The javadoc api link is 404 though, I don't see this on the howtorelease. Is it a manual step or is it not being triggered as part of the build?
      Hide
      Tom White added a comment -

      New patch which uses the apache-jar-resource-bundle JAR instead of a Whirr-specific one. I've tested with a clean local maven repo. Also reverted pom formatting change.

      Show
      Tom White added a comment - New patch which uses the apache-jar-resource-bundle JAR instead of a Whirr-specific one. I've tested with a clean local maven repo. Also reverted pom formatting change.
      Hide
      Patrick Hunt added a comment -

      The current howtorelease looks like a good start... some thing missing near the end but in general looks good to me.

      Show
      Patrick Hunt added a comment - The current howtorelease looks like a good start... some thing missing near the end but in general looks good to me.
      Hide
      Patrick Hunt added a comment -

      also the pom files seem to have been reformatted, some lines now exceed 80 chars unnecessarily.
      (specifically the namespace definitions on the <project> element)

      Show
      Patrick Hunt added a comment - also the pom files seem to have been reformatted, some lines now exceed 80 chars unnecessarily. (specifically the namespace definitions on the <project> element)
      Hide
      Patrick Hunt added a comment -

      mvn install fails with:

      [INFO] [remote-resources:process

      {execution: default}

      ]
      Downloading: http://jclouds.googlecode.com/svn/repo/org/apache/whirr/license-resources/0.1.0-incubating-SNAPSHOT/license-resources-0.1.0-incubating-SNAPSHOT.jar
      [INFO] Unable to find resource 'org.apache.whirr:license-resources:jar:0.1.0-incubating-SNAPSHOT' in repository jclouds (http://jclouds.googlecode.com/svn/repo)
      [INFO] ------------------------------------------------------------------------
      [ERROR] BUILD ERROR

      I don't see anything in BUILD.txt about this.

      Show
      Patrick Hunt added a comment - mvn install fails with: [INFO] [remote-resources:process {execution: default} ] Downloading: http://jclouds.googlecode.com/svn/repo/org/apache/whirr/license-resources/0.1.0-incubating-SNAPSHOT/license-resources-0.1.0-incubating-SNAPSHOT.jar [INFO] Unable to find resource 'org.apache.whirr:license-resources:jar:0.1.0-incubating-SNAPSHOT' in repository jclouds ( http://jclouds.googlecode.com/svn/repo ) [INFO] ------------------------------------------------------------------------ [ERROR] BUILD ERROR I don't see anything in BUILD.txt about this.
      Hide
      Tom White added a comment -

      New patch:

      • Added BUILD.txt which lists requirements and describes how to build from source.
      • Added a reference to the release notes from README.txt.

      I also added some instructions on branching to https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release, based on Hadoop's model.

      I think this is ready to go in and be used to drive a release.

      Show
      Tom White added a comment - New patch: Added BUILD.txt which lists requirements and describes how to build from source. Added a reference to the release notes from README.txt. I also added some instructions on branching to https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release , based on Hadoop's model. I think this is ready to go in and be used to drive a release.
      Hide
      Tom White added a comment -

      Thanks for taking a look, Patrick. Here's a new patch with the appropriate license headers added. Other changes:

      • Changed the version to 0.1.0-incubating-SNAPSHOT.
      • Add an Apache Incubator disclaimer.
      • Add extra metadata to jar's manifest.
      • Ensure LICENSE.txt and NOTICE.txt are included in jars (by using the maven-remote-resources-plugin).
      • Ensure source and javadoc jar files are build along with jar files to make user's IDE experience smoother.
      • A bit of maven simplification (removal of maven-compiler-plugin from all child projects, since it is inherited from the parent POM).

      Still to do:

      • Add some build instructions to the src distribution.
      • Figure out how to include release notes in the src distribution.
      • Document branching strategy on release page.
      Show
      Tom White added a comment - Thanks for taking a look, Patrick. Here's a new patch with the appropriate license headers added. Other changes: Changed the version to 0.1.0-incubating-SNAPSHOT. Add an Apache Incubator disclaimer. Add extra metadata to jar's manifest. Ensure LICENSE.txt and NOTICE.txt are included in jars (by using the maven-remote-resources-plugin). Ensure source and javadoc jar files are build along with jar files to make user's IDE experience smoother. A bit of maven simplification (removal of maven-compiler-plugin from all child projects, since it is inherited from the parent POM). Still to do: Add some build instructions to the src distribution. Figure out how to include release notes in the src distribution. Document branching strategy on release page.
      Hide
      Patrick Hunt added a comment -

      assemble.xml is missing a license header
      ditto "update-versions" script

      should we be documenting requirements (ruby for update-versions) somewhere? README.txt?

      Show
      Patrick Hunt added a comment - assemble.xml is missing a license header ditto "update-versions" script should we be documenting requirements (ruby for update-versions) somewhere? README.txt?
      Hide
      Tom White added a comment -

      Here's a patch which implements the process documented at https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release. This also changes the top-level POM so that the site can be built from the top-level (with aggregated Javadoc).

      Before applying the patch run:

      svn mv site/src src

      Show
      Tom White added a comment - Here's a patch which implements the process documented at https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release . This also changes the top-level POM so that the site can be built from the top-level (with aggregated Javadoc). Before applying the patch run: svn mv site/src src

        People

        • Assignee:
          Tom White
          Reporter:
          Tom White
        • Votes:
          0 Vote for this issue
          Watchers:
          0 Start watching this issue

          Dates

          • Created:
            Updated:
            Resolved:

            Development