Releasing OpenJPA
These instructions guide the release manager through the steps of making an official OpenJPA release.
Work in progress. Times are just guesses and some information may be missing.
Prerequisites
// TODO MDD Still may need some work...
- You should read the OpenJPA Release Policy to decide on the name of the new release, based on the content.
- You should read the Apache Release FAQ
- You must have shell access to people.apache.org
- You must have the following utilities installed on your local machine and available in your path:
- For Windows users, install Cygwin in addition to the above utilities
- Make sure the Net/openssh and Utils/gnupg packages are installed that come with Cygwin installation.
Tasks that need to be performed for each release
The example below uses 1.2.x as the new branch and 1.2.0 as the new release.
Monday, 12:00 |
Make sure the #One time setup steps have been performed.
|
---|---|
Monday, 12:01 |
??? 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 |
Monday, 12:02 |
Checkout the trunk/branch to release using command line svn.
|
Monday, 12:04 |
Update the text files which are included in the release. See instructions at Update release text files for details. |
Monday, 12:10 |
Commit these changes back to the branch $ svn commit -m "updating text files for 1.2.0 release" |
Monday, 12:11 |
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 :
|
Monday, 12:30 |
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,docbook-profile release:rollback # make changes $ svn commit -m "fixing formatting for 1.2.0 release" |
Monday, 12:31 |
Assuming the .tag files look OK you may proceed and do any other validation you feel necessary. The following list may be helpful
|
Monday, 12:52 |
Prepare the release. You'll be prompted for the version information and optionally your GPG passphrase again. $ mvn -Dmaven.test.execute=false -Prelease release:prepare For the 2.0.x code, different steps are required as there are problems with the maven-jar-plugin and maven-release-plugin when using the test-jar goal. See http://jira.codehaus.org/browse/MJAR-68 and http://jira.codehaus.org/browse/MRELEASE-285. $ mvn -DskipTests=true -Prelease release:prepare -DpreparationGoals="clean install" $ mvn clean install -Dtest=false -DfailIfNoTests=false -Dmaven.test.execute=false $ mvn -DskipTests=true -Prelease release:prepare -DpreparationGoals="clean install" |
Monday, 13:12 |
Check release.properties and make sure that the scm properties have the right version. Sometimes the scm location can be the previous version not the next version. For example if the new version is 1.2.2 you shouldn't see 1.2.1 in the file. |
Monday, 13:15 |
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#people.apache.org. $ mvn -Prelease,docbook-profile release:perform For the 2.0.x code, you'll need additional parameters, due to the test-jar issues. $ mvn -Prelease,docbook-profile,test-derby release:perform If your local OS userid doesn't match your Apache userid, then you'll have to set -Duser.name=<your_apache_id> on the cmdline and/or update your release profile in settings.xml |
Monday, 13:40 |
Create and upload the site. This step also uploads data to people.apache.org. $ cd target/checkout $ mvn -Prelease,docbook-profile site site:deploy For 2.x releases, this step is not needed, as the maven-release-plugin is configured with goals "deploy site site:deploy" |
Monday, 13:40 |
Unzip the binary archive the staging site directory # ssh to people.apache.org $ cd ~/public_html/openjpa/${pom.version}/staging-site $ unzip -qq apache-openjpa/downloads/apache-openjpa-${pom.version}-binary.zip Verify that the HTML links in staging-site/index.html are correct (usually only the downloads and docs links need to be updated to be prefixed with apache-openjpa/) |
Monday, 13:41 |
Send an email to dev@openjpa.apache.org requesting a vote. Vote email example |
Tuesday, Wednesday, Thursday |
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 |
Thursday, 13:41 |
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 |
Thursday, 14:00 |
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 $ chmod -R g+w /www/openjpa.apache.org/builds/1.2.0 # verify 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 |
Thursday, 14:10 |
Copy the distribution files to dist on people.apache.org. # ssh to people.apache.org # verify that md5 and sha1 files were generated for the download artifacts ls /www/openjpa.apache.org/builds/1.2.0/apache-openjpa/downloads/*.md5 ls /www/openjpa.apache.org/builds/1.2.0/apache-openjpa/downloads/*.sha1 # if no md5 and sha1 files are present, generate them. # Alternatively you can copy the artifacts from the staging-repo directory the checksums are generated there. for file in `ls . ` do md5 -q ${file} > ${file}.md5 sha1 -q ${file} > ${file}.sha1 done mkdir /www/www.apache.org/dist/openjpa/1.2.0 cp -r /www/openjpa.apache.org/builds/1.2.0/apache-openjpa/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 # remove the previous version from /dist. Ie if you're publishing 1.2.1 you would remove 1.2.0. # For this example we wouldn't remove anything, but for the next release (1.2.1) we'd do the following : $ rm -Rf /www/openjpa.apache.org/dist/openjpa/1.2.0 |
Thursday, 14:15 |
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. |
Friday, 14:15 |
After the mirrors have had time to update (24 hours to be on the safe side) update the Downloads and Documentation pages with the new release |
Friday, 14:15 |
Make a news announcement on the OpenJPA wiki. Once the news item is made, it won't show up on the front page unless you make some minor edit to the containing page (e.g., adding a newline somewhere). |
Friday, 14:15 |
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. |
Friday, 14:20 |
Make an announcement for the freshmeat.net OpenJPA project (optional) |
Friday, 14:30 |
Have a beer and enjoy your weekend while the world's grateful programmers revel in yet another high-quality release of Apache OpenJPA! |
One time setup
These setup steps only need to be performed on a particular machine once.
Developers using Linux workstations can skip over the references to Cygwin. If using Windows, install cygwin, including Utils/gnupg and Net/openssh packages.
Create and install a SSH key
1 |
Open a shell window. If using Windows, open a cygwin window. |
---|---|
2 |
Use ssh-keygen to create an SSH key. $ ssh-keygen -t dsa
|
3 |
$ cd ~/.ssh $ scp id_dsa.pub <your userid>@people.apache.org:id_dsa.pub $ You will be prompted for your password. |
4 |
Use ssh to login to people.apache.org $ cd ~ $ ssh <your userid>@people.apache.org
|
5 |
Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700. $ mkdir ~/.ssh $ chmod 700 ~/.ssh |
6 |
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
|
7 |
Exit out of this ssh session. |
8 |
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 If you are still prompted for a password, then you have not set up the ssh keys properly. Review the steps above and ensure that all of the steps were followed properly. Or, maybe the instructions are still not quite right and they still need some adjusting. In that case, please update the instructions accordingly. |
Create a GPG key
1 |
Open a shell window. If using Windows, open a cygwin window. |
---|---|
2 |
Generate a key-pair with gpg, using default key kind ("DSA and Elgamal") and ELG-E keys size (2048). $ gpg --gen-key
|
3 |
Backup your cygwin home directory to another media |
4 |
Add your public key to ![]() }}. 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> The |
5 |
Following the instructions in http://people.apache.org/~henkp/trust/ and ask someone in the OpenJPA project to sign your public key. |
6 |
Submit your public key to a key server. E.g. http://pgp.surfnet.nl:11371/ or http://pgp.mit.edu/ |
Update Maven settings for our servers
1 |
Create a settings.xml under .m2 (in your Document and Settings folder in Windows) |
---|---|
|
settings.xml <settings xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <servers> <server> <id>people.apache.org</id> <username>$USERNAME</username> <privateKey>$PATH_TO_PRIVATE_KEY</privateKey> <directoryPermissions>775</directoryPermissions> <filePermissions>644</filePermissions> </server> </servers> </settings>
|
Expose a copy of known hosts to Maven
Is this step even necessary? Due to the question mark below without an explanation of the new location for this alternate .ssh folder, I never performed these steps. And, the release process still seemed to work okay for me... The next person to use these instructions can verify whether any tricks had to be played with the .ssh folders...
1 |
From cygwin, ssh to people.apache.org, save the public key if prompted, and exit |
---|---|
|
cygwin will save the known hosts to your |
2 |
From cygwin (not Windows) create another |
3 |
Copy the |
Troubleshooting
Space Character in Build Root Path
Description |
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: org.apache.openjpa.revision.properties revision.number=Type 'svnversion --help' for usage. openjpa.version=1.0.1 |
---|---|
Solution |
Rename the path and remove all spaces. |
Merging local repository to remote repository in Cygwin/Windows
Description |
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:
|
---|---|
Solution |
As recommended in the descriptions. For example: 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 \; |
Cygwin/Windows File Path
Description |
For Cygwin/Windows user: file and folder path names using drive identifier (e.g. |
---|---|
Solution |
Consistently use the following naming conventions:
|
"Too many unapproved licenses:"
Description |
Encounter the "Too many unapproved licenses:" message while running the "license-verify-profile" profile in "
|
---|---|
Solution |
Avoid the followings:
|
Resources
- Apache Apache Release FAQ
- Signing Releases
- Wendy's notes on Release Signing
- Apache Mirroring Guidelines
- Struts Release Instructions (upon which these instructions are based)