Page History

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

• set MAVEN_OPTS=-Xmx512m (for documentation creation)
• Use Sun JDK (if possible)
  • If using IBM JDK, then also set MAVEN_OPTS=-Xdump:none (Avoids OOM heap dumps on selected tests. These extra files throw off the rat:check processing.)
• On Windows, use a cygwin window (vs a standard DOS prompt window).

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 branch 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

 $ svn commit -m "updating text files for 1.2.0 release"

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 :

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
   $ mvn -Prelease,docbook-profile release:prepare -DdryRun=true <snip> [INFO] [release:prepare] [INFO] Verifying that there are no local modifications... [INFO] Executing: svn --non-interactive status [INFO] Working directory: /home/mikedd/workspaces/temp/jpadev/branches/1.0.x [INFO] Checking dependencies and plugins for snapshots ... What is the release version for "OpenJPA"? (org.apache.openjpa:openjpa-parent) 1.2.0: : What is SCM release tag or label for "OpenJPA"? (org.apache.openjpa:openjpa-parent) openjpa-parent-1.2.0: : 1.2.0 What is the new development version for "OpenJPA"? (org.apache.openjpa:openjpa-parent) 1.2.1-SNAPSHOT: :

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.

Make sure the One time setup steps have been performed

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

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

Create and upload the site. This step also uploads data to people.apache.org.

 
$ cd target/checkout 
$ mvn -Prelease,docbook-profile site siterelease:deploy 

Unzip the binary archive the staging site directory

# ssh to people.apache.org 
$ cd ~/public_html/openjpa/rollback 
# make changes
$ svn commit -m "fixing formatting for 1.2.0/staging-site
$ unzip -qq apache-openjpa/downloads/apache-openjpa-1.2.0-binary.zip 
 release" 

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

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

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

If the vote passes copy the release artifacts from your home directory to the ibiblio-rsync-repository using the maven stage plugin.

 $ mvn stage:copy -Dsource="http://people.apache.org/~mikedd/openjpa/1.2.0/staging-repo" \
  -Dtarget="scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository" \
  -Dversion=1.2.0 \
  -DtargetRepositoryId=apache.releases

After the stage plugin completes it's a good idea to check the permissions on the file system.

$ ssh people.apache.org
$ cd /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openjpa/
$ ls -l openjpa-examples/1.2.0

# if you see something like the following you probably need to change the permissions.
# *-rw-r--r--*  1 mikedd  apcvs  59162 Jul 23 09:34 openjpa-examples-1.2.0-javadoc.jar

$ for file in `find /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openjpa/ -type d -iname '1.2.0'`\
  do \
  chmod -R g+w ${file} \ 
  done

$ ls -l openjpa-examples/1.2.0

# Now it should look something like this
# *-rw-rw--r--*  1 mikedd  apcvs  59162 Jul 23 09:34 openjpa-examples-1.2.0-javadoc.jar

-Prelease release:prepare 

Perform the release. This step will create a maven repository for use in testing on people.apache.org:/home/userName/public_html/openjpa/newVersion. You will may be prompted for your people.apache.org password several times if you have not added a ssh key to .authorized_keys. One time setup.

$ mvn -Prelease,docbook-profile release:perform 

Create and upload the site. This step also uploads data to people.apache.org.

 
$ cd target/checkout 
$ mvn -Prelease,docbook-profile site site:deploy 

Unzip the binary archive the staging site directory

# ssh to people.apache.org 
$ cd ~/public_html/openjpa/1.2.0/staging-site
$ unzip -qq apache-openjpa/downloads/apache-openjpa-1.2.0-binary.zip 

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

If the vote passes copy the release artifacts from your home directory to the ibiblio-rsync-repository using the maven stage plugin.

 $ mvn stage:copy -Dsource="http://people.apache.org/~mikedd/openjpa/1.2.0/staging-repo" \
  -Dtarget="scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository" \
  -Dversion=1.2.0 \
  -DtargetRepositoryId=apache.releases

After the stage plugin completes it's a good idea to check the permissions on the file system.

$ ssh

Copy build artifacts to the openjpa/builds location on people.apache.org.

# ssh to people.apache.org
$ cpcd -r ~/public_html/openjpa/1.2.0/staging-site/ /www/openjpa.apache.org/builds/1.2.0
$ chmod -R g+w /www/openjpa.apache.org/builds/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/openjpa/
$ ls -l openjpa-examples/1.2.0

# verifyif that /www/openjpa.apache.org/builds/1.2.0/docs/manual is populated correctly by comparing it to a previous release. 
$ rm /www/openjpa.apache.org/docs/latest
$ ln -fvs ../builds/1.2.0/apache-openjpa/docs/ /www/openjpa.apache.org/docs/latest 

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.

After the mirrors have had time to update (24 hours to be on the safe side) update the downloads page with the new release

Install PuTTY

Use ssh-keygen to create a SSH key.

In Windows platform, use PuttyGen to create a SSH key (see Putty help for details).

pscp your SSH public key authorized_keys saved in last step to ~/authorized_keys

Use PuTTY to login to people.apache.org

Create a ~\.ssh folder and change its file mode to 700.

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

Configure putty to use your private key and save the session

Install cgywin, including Utils/gnupg and Net/openssh packages, or install gpg from http://www.gnupg.org/(en)/download/index.html

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

Backup your cygwin home directory to another media

Add your public key to https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS and /www/www.apache.org/dist/openjpa/KEYS. 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.

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.