New Release Instructions (BETA)

Make sure the One time setup steps have been performed

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

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

Update the following files for the release

• openjpa-project/CHANGES.txt
• openjpa-project/NOTICE.txt
• openjpa-project/RELEASE-NOTES.txt
• openjpa-project/README.txt
• More information to come on how these are updated. BUILDING.txt and LICENSE.txt usually don't need to be updated but should be mentioned

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.

   $ mvn -Prelease 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.

$ mvn -Prelease release:rollback 
# make changes
$ svn commit -m "fixing formatting 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

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

 $ mvn -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 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 

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/public_htlm/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

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

# ssh to people.apache.org
$ cp -r ~/public_html/openjpa/1.2.0/staging-site/ www/openjpa.apache.org/builds/1.2.0
$ cd /www/openjpa.apache.org/builds/1.2.0/
$ unzip downloads/apache-openjpa-1.2.0-binary.zip
$ rm /www/openjpa.apache.org/docs/latest
$ ln -fvs ../builds/${pom.version}/apache-openjpa-${pom.version}/docs/ /www/openjpa.apache.org/docs/latest 

Copy the distribution files to dist on people.apache.org.

 
# ssh to people.apache.org
$ cp -r /www/openjpa.apache.org/builds/1.2.0/downloads/* /www/www.apache.org/dist/openjpa/1.2.0
$ chgrp -R openjpa /www/www.apache.org/dist/openjpa/1.2.0
$ chmod -R g+w /www/www.apache.org/dist/openjpa/1.2.0

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), make a news announcement on the OpenJPA wiki.

Make an announcement about the release on the users@openjpa.apache.org list (and, for major releases, on the announce@apache.org list as per the Apache Announcement Mailing Lists page). The announcement might look something like this.

Make an announcement for the freshmeat.net OpenJPA project (optional)

Have a beer and enjoy your weekend while the world's grateful programmers revel in yet another high-quality release of Apache OpenJPA!