Skip to main content
This revision made August 01, 2013 22:00, by ievans
« earlier revision revert to this « later revision

Steps to Release a New Tutorial Package


Prerequisites to Performing a Release

  1. All JIRA issues for the release have been resolved or deferred.
  2. All outstanding changes have been committed to SVN.
  3. All examples build without errors.
  4. The Maven Version plugin has been run to ensure the project dependencies are at their latest version.

Creating and Configuring the Branch for the Release

1. Create a branch for the new version:

 svn cp https://svn.java.net/svn/javaeetutorial~svn/trunk https://svn.java.net/svn/javaeetutorial~svn/branches/javaeetutorial-version number -m "Branching from trunk to the version number branch."

2. Check out the new branch:

 svn co https://svn.java.net/svn/javaeetutorial~svn/branches/javaeetutorial-version number

3. Update the version numbers in bundle/build.properties:

 pkg.version.major=7
 pkg.version.minor=0
 pkg.version.release=2
 pkg.version.build.major=1
 # increment pkg.version.build.minor by 1 when updating current version
 pkg.version.build.minor=1

4. In bundle/build.properties change the svn.root to use the branch, not the root:

 svn.root=https://svn.java.net/svn/javaeetutorial~svn/branches/javaeetutorial-${pkg.version.major}.${pkg.version.minor}.${pkg.version.release}
 #svn.root=https://svn.java.net/svn/javaeetutorial~svn/trunk

Updating the Bundled Documentation

  1. Download the latest RSB build ZIP file containing the HTML & PDF.
  2. Copy the HTML from the ZIP file to doc.
  3. Copy the PDF from the ZIP to doc and rename it to javaeetutorial7.pdf.
  4. Commit the changes to doc, making sure to add any new files.

Preparing the Example Tree with the Maven Release Plugin

1. Run the Maven Versions Plugin from the example root to update the version from version-SNAPSHOT to version.

 cd examples
 mvn versions:set -DnewVersion=version number

2. Ensure the example tree builds by entering:

 mvn package

Run the Packaging Scripts

Note: you must perform this task in a Unix environment (Linux, Solaris, OS X), not Windows. The reason is that the IPS packaging tools refer to files with Windows paths as literal file names in Unix. For example, the file that should be in docs/javaee-tutorial/doc/home.htm will actually be installed as docs/javaee-tutorial/doc\home.htm--that is, there will be a file called doc\home.htm located in docs/javaee-tutorial.

1. Run the packaging Ant scripts.

 cd bundle
 ant package

2. Test the package from the Update Center, configured to point to the internal IPS repository. 3. If the examples and documentation in the package are correct, inform release engineering of the updated package name and number. Release engineering will move the package from the internal IPS repository to the external IPS repository.

Update the Version in the Trunk Using the Maven Versions Plugin

1. Go to the example tree in the trunk.

 cd javaeetutorial/examples

2. Update the version number in trunk to the new SNAPSHOT version.

 mvn versions:set -DnewVersion=version number-SNAPSHOT

3. Commit the version change.

 mvn versions:commit

4. Commit the modified pom.xml files to trunk.

 svn commit -m "Updated version to version number-SNAPSHOT"
Difference compared to previous revision
<span>2. Ensure the example tree builds by entering: mvn package == Run the Packaging Scripts<span style="text-decoration:underline;color:green">'''Note''': you must perform this task in a Unix environment (Linux, Solaris, OS X), '''not''' Windows. The reason is that the IPS packaging tools refer to files with Windows paths as literal file names in Unix. For example, the file that should be in <code>docs/javaee-tutorial/doc/home.htm</code> will actually be installed as <code>docs/javaee-tutorial/doc\home.htm</code>--that is, there will be a file called <code>doc\home.htm</code> located in <code>docs/javaee-tutorial</code>. </span>1. Run the packaging Ant scripts. cd bundle ant package 2. Test the package from the Update Center, configured to point to the internal IPS repository.<span>
 
 
Close
loading
Please Confirm
Close