Prepare the source for release:

• Cleanup JIRA so the Fix Version in issues resolved since the last release includes this release version correctly.
• Update the files in openjpa-project -
  • Update the CHANGES.txt and RELEASE_NOTES.html based on the Text and HTML release reports from JIRA.
  • Review and update BUILDING.txt if needed.
• Stage any Roadmap or Release landing pages on the wiki.
• Use "mvn rat:check" to verify the source has the required headers before trying to release.
• Perform a full build (IANAL + tests) and TCK runs before trying to release.

Make sure the #One time setup steps have been performed.

• set MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=256m (especially for Java SE 6)
• Use Sun JDK (if possible)
  • If using IBM JDK, then also set the system property test.jvm.arguments to -Xdump:none (Avoids OOM heap dumps on selected tests. These extra files throw off the rat:check processing.) For example,

    Code Block
    none none
    mvn -Dtest.jvm.arguments="-Xdump:none" ...

• On Windows, use a cygwin window (vs a standard DOS prompt window) for the Release processing.

??? For new major releases (like 2.0.0) create a sub-branch off of the parent branch from which to make the release. Releasing from a branch will allow any cosmetic changes that need to be made for the release to be approved to be done without preventing other more disruptive advances in the trunk from potentially causing problems with the release. A branch can be made by running:

$ mvn release:branch -DbranchName=1.2.x

Checkout the trunk/branch to release using command line svn.

• Do not use Eclipse to do the checkout. The extra dot (.) files created by Eclipse throws off the rat:check processing.

  Code Block
  none none
  $ svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.2.x 1.2.x $ cd 1.2.x

Update the text files which are included in the release. See instructions at Update release text files for details.

Commit these changes back to the branch

Make sure the One time setup steps have been performed

Update the following files for the release

• openjpa-project/CHANGES.txt
• openjpa-project/NOTICE.txt
• openjpa-project/RELEASE-NOTES.txt
• openjpa-project/README.txt
  See Update release text files for details.

Validate that the release process completed as expected. The release plugin will create pom.xml.tag files which contain the changes that would have been committed to SVN. The only differences between pom.xml.tag and it's corresponding pom.xml file should be the version number. If other formatting changes have been made you should rollback the release and commit the changes manually.

$ mvn -Prelease release:rollback 
# make changes
$ svn commit -m "fixingupdating text formattingfiles for 1.2.0 release" 

Assuming the .tag files look OK you may proceed and do any other validation you feel necessary. The following list may be helpful

• verify signatures Verifying release signatures
• run examples. Running OpenJPA Examples
• if you have access to the TCK, run it Running the TCK

Do a dry run of the release plugin. The dry run will not commit any changes back to SVN and gives you the opportunity to verify that the release process will complete as expected. You will be prompted for the following information :

Prepare the release. You'll be prompted for the version information and optionally your GPG passphrase again.

1. The new release number (default 1.2.0)
2. The SCM tag (default apache-openjpa-1.2.0) *this should be changed to just 1.2.0
3. The new development version (default 1.2.1)
4. optional if you have not specified a GPG passphrase in settings.xml you will be prompted for it.

   Code Block
   none none

1. $ mvn -Prelease,docbook-profile release:prepare

Send an email to dev@openjpa.apache.org requesting a vote. Vote email example

A -1 vote does not necessarily mean that the vote must be redone however it is usually a good idea to rollback the release if a -1 vote is received. Recovering from a vetoed release

Update the JIRA versions page to mark the version as "released", and set the date to the date that the release was approved. You may also need to make a new release entry for the subsequent release.

Open a shell window. If using Windows, open a cygwin window.

Use ssh-keygen to create an SSH key.

$ ssh-keygen -t dsa

• Program defaults should be fine. No passphrase is required for the ssh key generation. The keys will be saved in ~/.ssh/id_dsa (private) and ~/.ssh/id_dsa.pub (public).

  Info
  See Authenticating By Public Key (OpenSSH) for a good description on why and how to perform this task.

scp your SSH public key ~/.ssh/id_dsa.pub created in last step to ~/id_dsa.pub on people.apache.org.

 
$ cd ~/.ssh
$ scp id_dsa.pub <your userid>@people.apache.org:id_dsa.pub 
$ You will be prompted for your password.

Use ssh to login to people.apache.org

$ cd ~
$ ssh <your userid>@people.apache.org

• At this point, you will still be prompted for your password.

Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700.

$ mkdir ~/.ssh
$ chmod 700 ~/.ssh

Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and change its file mode to 600.

$ mv ~/id_dsa.pub ~/.ssh/authorized_keys
$ chmod 600 ~/.ssh/authorized_keys

Exit out of this ssh session.

Start a new ssh session. No login should be required this time due to the private ssh key on your local box matching up with the public ssh key in your home directory (~/.ssh).

$ ssh <your userid>@people.apache.org

Open a shell window. If using Windows, open a cygwin window.

Generate a key-pair with gpg, using default key kind ("DSA and Elgamal") and ELG-E keys size (2048).

$ gpg --gen-key

• The program's default values should be fine. For the "Real Name" enter your full name (ie. Stan Programmer). For the "e-mail address" enter your apache address (ie. sprogrammer@apache.org). You will also be required to enter a "passphrase" for the GPG key generation. Keep track of this as you will need this for the Release processing.

  Info
  The generated keys are stored in $HOME/.gnupg or %HOME%\Application Data\gnupg subdirectory. Save the content in this subdirectory to a safe media. This contains your private key used to sign all the OpenJPA release materials.

Backup your cygwin home directory to another media

Add your public key to https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS and {{

}}. See the commands describe at the beginning of this KEYS file to perform this task. The gpg key-pair is used to sign the published artifacts for the OpenJPA releases.

$ gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name>

Following the instructions in http://people.apache.org/~henkp/trust/ and ask someone in the OpenJPA project to sign your public key.

Submit your public key to a key server. E.g. http://pgp.surfnet.nl:11371/ or http://pgp.mit.edu/

Create a settings.xml under .m2 (in your Document and Settings folder in Windows)

From cygwin, ssh to people.apache.org, save the public key if prompted, and exit

cygwin will save the known hosts to your ~/.ssh folder, but the script cannot access it there (from Windows)

From cygwin (not Windows) create another .ssh folder at

Copy the known_hosts file to the new .ssh folder

If there are spaces in the path to the build root subdirectory, the maven task uses to generate the revision number for the org.apache.openjpa.revision.properties yields incorrect data. For example:

revision.number=Type 'svnversion --help' for usage.
openjpa.version=1.0.1

Rename the path and remove all spaces.

The "maven-stage-plugin" is very sensitive to the parameters being passed to it, i.e. the source and target URL properties. When this plugin is used under Cygwin, make sure the following practices are used:

• Use absolute path in the find command's root directory.
  Problem symptom:

  Code Block

  $ find . -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy \ -Dsource=file://{} -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \ -Dversion=1.0.1 \; [INFO] Scanning for projects... [INFO] Searching repository for plugin with prefix: 'stage'. ........ [INFO] Downloading file from the source repository: [INFO] ------------------------------------------------------------------------ [ERROR] BUILD ERROR [INFO] ------------------------------------------------------------------------ [INFO] Error copying repository from file://./openjpa-all/target/site/m2-repository to \ scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository

• Quote and use the drive name in the path.
  Problem symptom:

  Code Block

  $ find /cygdrive/c/OpenJPA.1.0.1.Release/1.0.1 -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f /cygwin/c/tmp/maven-stage-plugin/pom.xml stage:copy \ -Dsource=file://{} -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \ -Dversion=1.0.1 \; [INFO] Scanning for projects... [INFO] Searching repository for plugin with prefix: 'stage'. ........ [INFO] Downloading file from the source repository: [INFO] ------------------------------------------------------------------------ [ERROR] BUILD ERROR [INFO] ------------------------------------------------------------------------ [INFO] Error copying repository from file:///cygdrive/c/OpenJPA.1.0.1.Release/1.0.1/openjpa-all/target/site/m2-repository to scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository Embedded error: Could not read from file: c:\cygdrive\c\OpenJPA.1.0.1.Release\1.0.1\openjpa-all\target\site\m2-repository \cygdrive\c\OpenJPA.1.0.1.Release\1.0.1\openjpa-all\target\site\m2-repository (Access is denied.)

• Specify the people.apache.org user id in the target property.
  Problem symptom:

  Code Block

  $ find "c:/OpenJPA.1.0.1.Release/1.0.1" -name m2-repository -not -path "*openjpa-project*" \ -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy -Dsource=file://{} -Dtarget=scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \ -Dversion=1.0.1 \; [INFO] Scanning for projects... [INFO] Searching repository for plugin with prefix: 'stage'. [INFO] ---------------------------------------------------------------------------- ........ [INFO] Downloading file from the source repository: /org/apache/openjpa/openjpa/maven-metadata.xml.sha1 [INFO] Downloading metadata from the target repository. Password:: ********* ........ Password:: ********* [INFO] ------------------------------------------------------------------------ [ERROR] BUILD ERROR [INFO] ------------------------------------------------------------------------ [INFO] Error copying repository from file://c:/OpenJPA.1.0.1.Release/1.0.1/openjpa-all/target/site/m2-repository to \ scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository

As recommended in the descriptions.

find "c:/OpenJPA.1.0.1.Release/1.0.1" -name m2-repository -not -path "*openjpa-project*" \
    -exec mvn -f "c:/tmp/maven-stage-plugin/pom.xml" stage:copy \
    -Dsource=file://{} \
    -Dtarget=scp://allee8285@people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository \
    -Dversion=1.0.1 \;

For Cygwin/Windows user: file and folder path names using drive identifier (e.g. C:\OpenJPA Release\1.0.1 ) in commands can be expressed as /cygwin/c/OpenJPA Release/1.0.1/. This form of path name specification may have inconsistent and undesirable behaviors.

Consistently use the following naming conventions:

• Continue to use the Windows form of path name, e.g. C:\a\b\c
• Use '/' instead of '\' character as file separator, e.g. C:/a/b/c
• Quote all path name using '"' character, e.g. "C:/a/b/c"
• Avoid using space characters in path name, e.g. "C:/OpenJPA.Release/1.0.1"

Encounter the "Too many unapproved licenses:" message while running the "license-verify-profile" profile in "mvn deploy site..." step. This is caused by extra artifacts in the build tree that the license verification plugin does not recognized. Examples of these artifacts are:

1. Eclipse control files, .classpath, .project
2. User created log files

Avoid the followings:

1. Don't use Eclipse's svn plugin to "Check out" files to a Eclipse project. Simply use the svn command, as described in the release instructions.
2. Don't create, directly or indirectly, any files under the release build tree.
3. Don't use the IBM JDK. By default, the IBM JDK will create heap dumps when hitting the OOM condition in some of our tests. These extra files throw off the rat:check processing. If you must use the IBM JDK, then also set MAVEN_OPTS=-Xdump:none.