You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by al...@apache.org on 2012/11/30 17:56:08 UTC
svn commit: r1415738 [8/9] - in /openjpa/site/trunk: content/
original.cwiki.content/
Added: openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.0.x-or-1.1.x-(old-scp-steps).cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.0.x-or-1.1.x-%28old-scp-steps%29.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.0.x-or-1.1.x-(old-scp-steps).cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.0.x-or-1.1.x-(old-scp-steps).cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,343 @@
+{excerpt:hidden=true}Instructions for creating an official OpenJPA release{excerpt}
+{scrollbar}
+
+h1. Making an OpenJPA 1.0.x or 1.1.x Release
+
+These instructions guide the release manager through the steps of making an official OpenJPA release.
+
+h2. Prerequisites
+
+# You should read the [OpenJPA Release Policy|OpenJPA Release Policy] to decide on the name of the new release, based on the content.
+# You should read the Apache [Release FAQ|http://www.apache.org/dev/release.html]
+# 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:
+#* [JDK 1.4 / 1.5|http://java.sun.com/]
+#* [ssh|http://www.openssh.com/]
+#* [Maven 2|http://maven.apache.org/]
+#* [gnupg|http://www.gnupg.org/]
+# For Windows users, install [Cygwin|http://cygwin.com/] in addition to the above utilities
+#* Make sure the Net/openssh and Utils/gnupg packages are installed that come with Cygwin installation.
+#* Optional: [Putty|http://www.chiark.greenend.org.uk/~sgtatham/putty/]
+
+h2. Tasks that need to be performed for each release
+
+{info}In the examples below, it is assumed that the release name will be *1.0.1*, and that the current checked-in version name is *1.0.1-SNAPSHOT* and stored in the branch named *1.0.x*.{info}
+|| Monday, 12:00 | Make sure the [#One time setup] steps have been performed \\ ||
+|| Monday, 12:01 | 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: \\
+{code:none}
+svn copy -m "OpenJPA Release 1.0.1 branch" \
+ https://svn.apache.org/repos/asf/openjpa/branches/1.0.x \
+ https://svn.apache.org/repos/asf/openjpa/branches/1.0.1
+{code} ||
+|| Monday, 12:02 | Check out a clean branch from which to build the release: \\
+{code:none}
+svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.0.1
+cd 1.0.1
+{code} \\
+{note}Make sure there is no space characters in the path to the build root subdirectory, i.e. "c:\OpenJPA 1.0.1 Release\build". See "[#Space Character in Build Root Path]"{note} ||
+|| Monday, 12:03 | Update all the POMs to remove "-SNAPSHOT" suffix from the version. If you have perl installed, you can easily do it with a single command: \\
+{code:none}
+perl -pi -e "s;<version>1.0.1-SNAPSHOT</version>;<version>1.0.1</version>;g" \
+ pom.xml */pom.xml */*/pom.xml
+{code}
+Update the {{<scm.dir>}} property in the top level pom.xml to the 1.0.1 release. \
+Update the {{<developer>}} element in the top level pom.xml if new committers are added or removed. This applies to the 1.0.x branch only. ||
+|| Monday, 12:10 | Verify that LICENSE.txt contains up to date licenses for any dependencies which are included in our distribution.\\ Any jars or source code which is included with the OpenJPA distribution that is not covered by the Apache license must be noted in LICENSE.txt. Two examples of this are the persistence and orm dtds (licensed under the CDDL) and Serp. If any new non Apache dependencies have been introduced they will have to be covered here as well. If any discrepancies are found update LICENSE.txt and commit the changes. \\ ||
+|| Monday, 12:15 | Update BUILDING.txt, CHANGES.txt and RELEASE-NOTES.html \\
+* BUILDING.txt should be included in the source tarball and contains instructions on how to build OpenJPA. Prior to shipping a release we should ensure that those instructions are accurate.
+* CHANGES.txt contains a text representation of all the changes which have been made since the preceding release. Most of the contents of this file can be generated through JIRA's release notes mechanism [here|http://issues.apache.org/jira/secure/ConfigureReleaseNote.jspa?projectId=12310351]
+* RELEASE-NOTES.html contains general information on the OpenJPA project as well as an html version of the changes since the preceding version. The html change log may also be generated via JIRA.\\
+||
+|| Monday, 12:20 | Commit the POM changes \\
+{code:none}
+svn commit -m "Updated to version 1.0.1 for the release"
+{code} ||
+|| Monday, 12:21 | Perform an initial build and install it in the local repository (this step is only required because of an [open bug|http://jira.codehaus.org/browse/MJAVADOC-116] with Maven's javadoc plugin): \\
+{code:none}
+mvn clean install -Dtest=false
+{code} ||
+|| Monday, 12:23 | Now build the release locally, which will build and test, run the Apache [Release Audit Tool|http://mojo.codehaus.org/rat-maven-plugin/] to verify license headers, generate the javadoc and docbook PDF and HTML, run through the JPA TCK, build the source and binariy assemblies in *target/site/downloads/*, and sign the release files. \\
+{code:none}
+export MAVEN_OPTS=-Xmx1000m
+mvn --batch-mode deploy site \
+ -Ptck-profile,examples-profile,license-verify-profile,javadoc-profile,docbook-profile,sign-release \
+ -Djava14.jar=${JAVA_HOME}/../../1.4/Classes/classes.jar \
+ -Dtck.zip=${HOME}/.m2/privaterepos/jpa-1_0b-tck.zip
+{code}\\
+{note}This operation will also sign the release files with the *gpg* utility using the <username>@apache.org key. If your code signing key is under a different address, specify it by appending the following argument to the command above: \-Dopenjpa.release.keyAlias=mysigningalias@somedomain.org{note}\\
+{note}The *java14.jar* path should be changed to the local install path for the JDK 1.4 rt.jar so that JDK 1.4 verification can take place.{note}\\
+{note}The *tck.zip* path should be changed to the local install path to the JPA TCK so that the TCK can be run against the release. If you are not licensed to access the TCK, remove the {{tck-profile}} profile and {{-Dtck.zip}} property from the command. Ask someone who has access to run the TCK for you. {note}\\
+{note} The {{examples-profile}} has problem running automatically in this maven build task. You will need to run the examples manually. Run the maven command without the {{examples-profile}}, then perform the following steps to run the example:
+{code}
+mkdir openjpa-integration\examples\target\examples
+unzip target\site\downloads\apache-openjpa-1.0.1-binary.zip -d openjpa-integration\examples\target\examples
+cd openjpa-integration\examples\target\examples\apache-openjpa-1.0.1\examples\hellojpa
+ant
+cd ..\relations
+ant
+cd ..\reversemapping
+ant
+{code}
+{note} ||
+|| Monday, 13:00 | Verify the signatures: \\
+{code:none}
+gpg --multifile --verify target/site/downloads/*.asc
+{code} ||
+|| Monday, 13:01 | Upload the release candidate to [http://openjpa.apache.org/builds/1.0.1/downloads/]: \\
+{code:none}
+mvn site:deploy
+{code}{warning}
+Bear in mind that uploads to *people.apache.org/www/openjpa.apache.org/builds/* are not visible at [http://openjpa.apache.org/builds] until after the hourly synchronization has taken place, as described at [http://www.apache.org/dev/project-site.html].
+{warning}||
+|| Monday, 15:00 | Start a vote for the release on the [mailto:dev@openjpa.apache.org] mailing list. Votes made by committers and members of the OpenJPA project are considered binding for this vote. For an example of the mail, see [this archived 1.0.0 vote|http://www.nabble.com/-VOTE--Approve-OpenJPA-1.0.0-release-%284th-attempt%29-p12305349.html] ||
+|| Tuesday, Wednesday | While waiting for the vote to complete, perform whatever manual review and testing on the release you deem appropriate. ||
+|| Thursday, 15:00 | If the vote is successful after 3 days tally the votes in an email to [mailto:dev@openjpa.apache.org], like [this one|http://www.nabble.com/-VOTE-RESULT--Approve-OpenJPA-1.0.0-release-%284th-attempt%29-p12379716.html]. \\ ||
+|| Thursday, 15:10 | Make the OpenJPA assemblies available to the Apache mirroring system by copying them over on *people.apache.org*:\\
+{code:none}
+ssh people.apache.org
+cp -r /www/openjpa.apache.org/builds/1.0.1/downloads/* /www/www.apache.org/dist/openjpa/1.0.1
+chgrp -R openjpa /www/www.apache.org/dist/openjpa/1.0.1
+chmod -R g+w /www/www.apache.org/dist/openjpa/1.0.1
+{code}{warning}
+The OpenJPA binary release will be available via the link [http://www.apache.org/dyn/closer.cgi/openjpa/1.0.1/apache-openjpa-1.0.1-binary.zip] after 24 hours, as per the [Apache mirroring information|http://apache.org/dev/mirrors.html].
+{warning}||
+|| Thursday, 15:15 | Now that the release is locked down, convert the writeable 1.0.1 branch to a (du jure) read-only tag: \\
+{code:none}
+svn mv -m "OpenJPA Release 1.0.1 tag" \
+ https://svn.apache.org/repos/asf/openjpa/branches/1.0.1 \
+ https://svn.apache.org/repos/asf/openjpa/tags/1.0.1
+{code} ||
+|| Thursday, 15:16 | Check out the parent branch and bump up the release number to be the next snapshot version: \\
+{code:none}
+svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.0.x
+cd 1.0.x
+perl -pi -e "s;<version>1.0.1-SNAPSHOT</version>;<version>1.0.2-SNAPSHOT</version>;g" \
+ pom.xml */pom.xml */*/pom.xml
+svn commit -m "Updating version in branch to 1.0.2-SNAPSHOT"
+{code} ||
+|| Thursday, 15:20 | Update the [http://cwiki.apache.org/openjpa/downloads.html] page with links to the download mirrors, using the existing entries as templates. {note}All artifacts (*apache-openjpa-1.0.1-binary.zip* and *apache-openjpa-1.0.1-source.zip*) *must* link to the mirrors, but signatures (*apache-openjpa-1.0.1-binary.zip.asc* and *apache-openjpa-1.0.1-source.zip.asc*) *must not* link to mirrors.{note}||
+|| Thursday, 15:30 | The documentation on the server-side must manually be extracted on *people.apache.org*, and the links at [http://openjpa.apache.org/documentation.html] need to be updated with the new versions and the "latest" documentation symbolic links need to be updated: \\
+{code:none}
+cd /www/openjpa.apache.org/builds/1.0.1/
+unzip downloads/apache-openjpa-1.0.1-binary.zip
+rm /www/openjpa.apache.org/docs/latest
+ln -fvs ../builds/1.0.1/apache-openjpa-1.0.1/docs/ /www/openjpa.apache.org/docs/latest
+{code} \\
+Then point the links on [http://openjpa.apache.org/documentation.html] to: \\
+ * HTML Manual: [http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/manual/index.html] \\
+ * HTML Manual (single-page): [http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/manual/manual.html] \\
+ * PDF Manual: [http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/manual/manual.pdf] \\
+ * Javadocs: [http://openjpa.apache.org/builds/1.0.1/apache-openjpa-1.0.1/docs/javadoc/index.html] \\
+||
+|| Thursday, 15:45 | Merge the staged maven2 repository jars to with the official repository to rsync. This is currently a difficult process that requires the *maven-staging-plugin*, which much be built from source. The process looks something like this (executed in the root of your local OpenJPA checkout): \\
+{code:none}
+svn co http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-stage-plugin/ \
+ /tmp/maven-stage-plugin
+mvn -f /tmp/maven-stage-plugin/pom.xml clean install
+for i in $(find openjpa-* -name m2-repository | egrep -v "openjpa-project|openjpa-integration|openjpa-examples"); do
+ cd $i
+ mvn stage:copy -Dsource=file://. \
+ -Dtarget=scp://people.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository \
+ -Dversion=1.0.1
+ cd -
+done
+{code}{warning}
+This process requires Maven 2.0.5. It is currently quite delicate and error-prone. Once the *maven-stage-plugin* is released, it should be possible to make it more automated.
+{warning}
+{info}
+Window/Cygwin user: See [#Merging local repository to remote repository in Cygwin/Windows]
+{info}
+{info}
+Linux users: You may need to change the '-Dsource=' option to read '-Dsource=file:{}'. The file://{} syntax may result in errors creating the wagon file with errors like: "Repository path /openjpa-jdbc-5/target/site/m2-repository does not exist, and cannot be created."
+{info}
+|| Thursday, 16:00 | Update the [JIRA versions | https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310351] 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, 16:00 | After the mirrors have had time to update (24 hours to be on the safe side), make a [news announcement|http://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=openjpa] on the OpenJPA wiki. {note}Once the news item is made, it won't show up on the [front page|http://cwiki.apache.org/openjpa/] unless you make some minor edit to the containing page (e.g., adding a newline somewhere).{note} ||
+|| Friday, 16:05 | Make an announcement about the release on the [mailto:users@openjpa.apache.org] list (and, for major releases, on the [mailto:announce@apache.org] list as per [the Apache Announcement Mailing Lists page|http://www.apache.org/foundation/mailinglists.html#foundation-announce]). The announcement might look something like [this|http://www.nabble.com/-ANNOUNCE--Apache-OpenJPA-1.0.0-released-p12397604.html]. ||
+|| Friday, 16:10 | Make an announcement for the [freshmeat.net OpenJPA project|http://freshmeat.net/projects/openjpa/] (optional) ||
+|| Friday, 17:00 | Have a beer and enjoy your weekend while the world's grateful programmers revel in yet another high-quality release of Apache OpenJPA! ||
+
+h2. One time setup
+
+These setup steps only need to be performed on a particular machine once.
+{info}Developers using Linux workstations can skip over the references to PuTTY and Cygwin
+{info}
+
+h3. Create and install a SSH key
+
+|| 1 | Install PuTTY ||
+|| 2a | Use ssh-keygen to create a SSH key.
+{info} See [Authenticating By Public Key (OpenSSH)|http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html] for a good description on why and how to perform this task.
+{info} ||
+|| 2b | In Windows platform, use PuttyGen to create a SSH key (see Putty help for details).
+{info}
+* Use "*SSH-2 DSA*" key type and *1024*-bit key size.
+* Copy the content of the "Public key for pasting...." and save it to a file named {{authorized_keys}} for later use.
+* The private key saved by PuTTYGen can only be used in Putty configuration.
+{info} ||
+|| 3 | {{pscp}} your SSH public key {{authorized_keys}} saved in last step to {{\~/authorized_keys}} ||
+|| 4 | Use PuTTY to login to people.apache.org ||
+|| 5 | Create a {{\~\.ssh}} folder and change its file mode to 700.
+|| 6 | Move or append {{\~/authorized_keys}} to {{\~/.ssh/authorized_keys}} and change its file mode to 600.
+{info}
+* Each public key in the {{authorized_keys}} spans only one line.
+** For example: "{{ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107}}"
+* '#' in the first column is a comment line.
+{info} ||
+|| 7 | Configure putty to use your private key and save the session
+{info}
+Specify your private key in the "Connection -> SSH -> Auth" category in Putty configuration.
+{info}
+||
+
+h3. Create a PGP key
+
+|| 1 | Install cgywin, including *Utils/gnupg* and *Net/openssh* packages, or install gpg from {{[http://www.gnupg.org/(en)/download/index.html]}} ||
+|| 2 | Generate a key-pair with {{$ gpg \--gen-key}} using default key kind ("DSA and Elgamal") and ELG-E keys size (2048).
+{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.
+{info} ||
+|| 3 | Backup your cygwin home directory to another media ||
+|| 4 | 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. ||
+|| 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/]||
+
+h3. Update Maven settings for our servers
+
+|| 1 | Create a settings.xml under .m2 (in your Document and Settings folder in Windows) ||
+| | {code:xml|title=settings.xml|borderStyle=solid}
+<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>
+{code}
+{info}
+{{$PATH_TO_PRIVATE_KEY}} is the path to the private key generated for ssh. E.g. /home/yourLocalUserId/.ssh/id_dsa.
+{info} |
+
+h3. Expose a copy of known hosts to Maven
+
+|| 1 | 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) |
+|| 2 | From cygwin (not Windows) create another {{.ssh}} folder at (?) ||
+|| 3 | Copy the {{known_hosts}} file to the new {{.ssh}} folder ||
+
+h2. Troubleshooting
+
+h3. 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:
+{code:title=org.apache.openjpa.revision.properties|borderStyle=solid}
+revision.number=Type 'svnversion --help' for usage.
+openjpa.version=1.0.1
+{code} ||
+|| Solution | Rename the path and remove all spaces. ||
+
+h3. 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:
+* Use absolute path in the find command's root directory. \\
+Problem symptom:
+{code}
+$ 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
+{code}
+* Quote and use the drive name in the path.
+Problem symptom:
+{code}
+$ 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.)
+{code}
+* Specify the people.apache.org user id in the target property.
+Problem symptom:
+{code}
+$ 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
+{code} ||
+|| Solution | As recommended in the descriptions.
+{note}For example:
+{code}
+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 \;
+{code} {note} ||
+
+h3. Cygwin/Windows File Path
+
+|| Description | 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.||
+|| Solution | 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}}"
+ ||
+
+h3. "Too many unapproved licenses:"
+
+|| Description | 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:
+# Eclipse control files, .classpath, .project
+# User created log files ||
+|| Solution | Avoid the followings:
+# 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.
+# Don't create, directly or indirectly, any files under the release build tree.
+ ||
+
+h2. Resources
+
+* Apache Apache [Release FAQ|http://www.apache.org/dev/release.html]
+* [Signing Releases|http://apache.org/dev/release-signing.html]
+* [Wendy's notes on Release Signing|http://wiki.wsmoak.net/cgi-bin/wiki.pl?ReleaseSigning]
+* Apache [Mirroring Guidelines|http://apache.org/dev/mirrors.html]
+* Struts [Release Instructions|http://cwiki.apache.org/WW/creating-and-signing-a-distribution.html] (upon which these instructions are based)
Added: openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.2.x-(old-scp-steps).cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.2.x-%28old-scp-steps%29.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.2.x-(old-scp-steps).cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/releasing-openjpa-1.2.x-(old-scp-steps).cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,393 @@
+{excerpt:hidden=true}Instructions for creating an official OpenJPA release{excerpt}
+h1. 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._
+
+h2. Prerequisites
+
+// TODO MDD Still may need some work...
+
+# You should read the [OpenJPA Release Policy|OpenJPA Release Policy] to decide on the name of the new release, based on the content.
+# You should read the Apache [Release FAQ|http://www.apache.org/dev/release.html]
+# 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:
+#* Java SE 5.0 (for 1.2.x and 1.3.x) or Java SE 6 (for 2.0.x) (prefer Sun JDK over IBM JDK)
+#* [Maven 2|http://maven.apache.org/] (at least version 2.0.10)
+#* [ssh|http://www.openssh.com/] (cygwin covers this on Windows)
+#* [gnupg|http://www.gnupg.org/] (cygwin covers this on Windows)
+# For Windows users, install [Cygwin|http://cygwin.com/] in addition to the above utilities
+#* Make sure the Net/openssh and Utils/gnupg packages are installed that come with Cygwin installation.
+
+h2. 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, 8:00 \\ | 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.
+|| Monday, 12:00 \\ | 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:none}
+mvn -Dtest.jvm.arguments="-Xdump:none" ...
+{code}
+* On Windows, use a cygwin window (vs a standard DOS prompt window) for the Release processing.||
+|| 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: \\
+{code:none}
+$ mvn release:branch -DbranchName=1.2.x
+{code} ||
+|| Monday, 12:02 \\ | 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:none} $ svn checkout https://svn.apache.org/repos/asf/openjpa/branches/1.2.x 1.2.x
+$ cd 1.2.x {code}||
+|| 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
+{code:none} $ svn commit -m "updating text files for 1.2.0 release"
+{code} ||
+|| 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 :
+# The new release number (default 1.2.0)
+# The SCM tag (default apache-openjpa-1.2.0) *this should be changed to just 1.2.0
+# The new development version (default 1.2.1)
+# _optional_ if you have not specified a GPG passphrase in settings.xml you will be prompted for it.
+{code: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: :
+ {code} ||
+|| 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.
+{code:none}$ mvn -Prelease,docbook-profile release:rollback
+# make changes
+$ svn commit -m "fixing formatting for 1.2.0 release" {code} ||
+|| 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
+* verify signatures [Verifying release signatures]
+* run examples. [Running OpenJPA Examples]
+* if you have access to the TCK, run it [Running the TCK]||
+|| Monday, 12:52 \\ | Prepare the release. You'll be prompted for the version information and optionally your GPG passphrase again.
+{code:none} $ mvn -Dmaven.test.execute=false -Prelease release:prepare {code}
+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].
+{code:none} $ 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" {code} ||
+|| 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. \\
+{note}Backup (zip or tar) your local directory in case you need to rollback the release.{note} ||
+|| 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].
+{code:none}$ mvn -Prelease,docbook-profile release:perform {code}
+For the 2.0.x code, you'll need additional parameters, due to the test-jar issues.
+{code:none}$ mvn -Prelease,docbook-profile,test-derby release:perform {code}
+{info} 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 {info} ||
+|| Monday, 13:40 \\ | Create and upload the site. This step also uploads data to people.apache.org.
+For 1.x releases:
+{code:none}
+$ cd target/checkout
+$ mvn -Prelease,docbook-profile site site:deploy {code}
+{warning} *For 2.x releases*, this step is not needed, as the maven-release-plugin is configured with goals "deploy site site:deploy" {warning} ||
+|| Monday, 13:41 \\ | Unzip the binary archive the staging site directory
+{code:none}
+# ssh to people.apache.org
+$ cd ~/public_html/openjpa/${pom.version}/staging-site
+$ unzip -qq apache-openjpa/downloads/apache-openjpa-${pom.version}-binary.zip
+{code}
+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/)
+{note} *For the 2.x releases*, not all of the *tests.jar are being signed (only 1 of 9) so you will need to manually sign and upload the signatures to the staging-repo. \\
+See [http://people.apache.org/~henkp/repo/faq.html] and [http://www.apache.org/dev/release-signing.html#openpgp-ascii-detach-sig] {note}
+|| Monday, 13:42 \\ | Send an email to dev@openjpa.apache.org requesting a vote. [Vote email example|http://markmail.org/message/siwhrukuyu64cncg]
+|| 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:42 \\ | If the vote passes copy the release artifacts from your home directory to the ibiblio-rsync-repository using the maven stage plugin.
+{code:none} $ 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
+{code}
+After the stage plugin completes it's a good idea to check the permissions on the file system.
+{code}
+$ 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
+{code}||
+|| Thursday, 14:00 \\ | Copy build artifacts to the openjpa/builds location on people.apache.org.
+{code:none}# 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 {code} ||
+|| Thursday, 14:10 \\ | Copy the distribution files to dist on people.apache.org.
+{code:none}
+# 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
+{code}||
+|| Thursday, 14:15 | Update the [JIRA versions | https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310351] 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|http://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=openjpa] on the OpenJPA wiki. {info}Once the news item is made, it won't show up on the [front page|http://cwiki.apache.org/openjpa/] unless you make some minor edit to the containing page (e.g., adding a newline somewhere).{info} ||
+|| Friday, 14:15 | Make an announcement about the release on the [mailto:users@openjpa.apache.org] list (and, for major releases, on the [mailto:announce@apache.org] list as per [the Apache Announcement Mailing Lists page|http://www.apache.org/foundation/mailinglists.html#foundation-announce]). The announcement might look something like [this|http://www.nabble.com/-ANNOUNCE--Apache-OpenJPA-1.0.0-released-p12397604.html]. ||
+|| Friday, 14:20 | Make an announcement for the [freshmeat.net OpenJPA project|http://freshmeat.net/projects/openjpa/] (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! ||
+
+h2. One time setup
+
+These setup steps only need to be performed on a particular machine once.
+{info}Developers using Linux workstations can skip over the references to Cygwin. If using Windows, install cygwin, including *Utils/gnupg* and *Net/openssh* packages.
+{info}
+
+h3. 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.
+{note}Follow the latest steps and guides on the ASF website at [http://www.apache.org/dev/openpgp.html#generate-key] as you need to disable using SHA1 and new keys should be 4096 bits.{note}
+{code:none}
+$ ssh-keygen -t dsa
+{code}
+* 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)|http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html] for a good description on why and how to perform this task.
+{info} ||
+|| 3 | {{scp}} your SSH public key ~/.ssh/id_dsa.pub created in last step to ~/id_dsa.pub on people.apache.org.
+{code:none}
+$ cd ~/.ssh
+$ scp id_dsa.pub <your userid>@people.apache.org:id_dsa.pub
+$ You will be prompted for your password.
+{code} ||
+|| 4 | Use ssh to login to people.apache.org
+{code:none}
+$ cd ~
+$ ssh <your userid>@people.apache.org
+{code}
+* At this point, you will still be prompted for your password. ||
+|| 5 | Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700.
+{code:none}
+$ mkdir ~/.ssh
+$ chmod 700 ~/.ssh
+{code} ||
+|| 6 | Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and change its file mode to 600.
+{code:none}
+$ mv ~/id_dsa.pub ~/.ssh/authorized_keys
+$ chmod 600 ~/.ssh/authorized_keys
+{code}
+{info}
+* Each public key in the {{authorized_keys}} spans only one line.
+** For example: "{{ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107}}"
+* '#' in the first column is a comment line.
+{info} ||
+|| 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).
+{code:none}
+$ ssh <your userid>@people.apache.org
+{code}
+{info}
+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. :-)
+{info}
+||
+
+h3. 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).
+{code:none}
+$ gpg --gen-key
+{code}
+* 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.
+{info} ||
+|| 3 | Backup your cygwin home directory to another media ||
+|| 4 | Add your public key to {{[https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS]}} and {{http://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.
+{code:none}
+$ gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name>
+{code}
+{info}The {{[https://svn.apache.org/repos/asf/openjpa/site/docs/KEYS]}} file is updated via normal svn commit procedures. How the {{http://www.apache.org/dist/openjpa/KEYS}} file gets updated is still a mystery to me...
+{info} ||
+|| 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/]||
+
+h3. Update Maven settings for our servers
+
+|| 1 | Create a settings.xml under .m2 (in your Document and Settings folder in Windows) ||
+| | {code:xml|title=settings.xml|borderStyle=solid}
+<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>
+{code}
+{info}
+* {{$USERNAME}} is the remote username on people.apache.org, not your local userid.
+* {{$PATH_TO_PRIVATE_KEY}} is the path to the private key generated for ssh. E.g. /home/yourLocalUserId/.ssh/id_dsa. For Windows' cygwin users, you will need to enter the full cygwin path: /cygdrive/c/cygwin/home/yourLocalUserId/.ssh/id_dsa.
+* You can also enter a PGP passphrase stanza: <passphrase>..</passphrase>. If you don't use this in your settings.xml file, then you will be prompted for it during the Release processing.
+{info} |
+
+h3. Expose a copy of known hosts to Maven
+{info}
+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...
+{info}
+
+|| 1 | 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) |
+|| 2 | From cygwin (not Windows) create another {{.ssh}} folder at (?) ||
+|| 3 | Copy the {{known_hosts}} file to the new {{.ssh}} folder ||
+
+h2. Troubleshooting
+
+h3. 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:
+{code:title=org.apache.openjpa.revision.properties|borderStyle=solid}
+revision.number=Type 'svnversion --help' for usage.
+openjpa.version=1.0.1
+{code} ||
+|| Solution | Rename the path and remove all spaces. ||
+
+h3. 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:
+* Use absolute path in the find command's root directory. \\
+Problem symptom:
+{code}
+$ 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
+{code}
+* Quote and use the drive name in the path.
+Problem symptom:
+{code}
+$ 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.)
+{code}
+* Specify the people.apache.org user id in the target property.
+Problem symptom:
+{code}
+$ 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
+{code} ||
+|| Solution | As recommended in the descriptions.
+{note}For example:
+{code}
+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 \;
+{code} {note} ||
+
+h3. Cygwin/Windows File Path
+
+|| Description | 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.||
+|| Solution | 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}}"
+ ||
+
+h3. "Too many unapproved licenses:"
+
+|| Description | 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:
+# Eclipse control files, .classpath, .project
+# User created log files ||
+|| Solution | Avoid the followings:
+# 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.
+# Don't create, directly or indirectly, any files under the release build tree.
+# 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.
+ ||
+
+h2. Resources
+
+* Apache Apache [Release FAQ|http://www.apache.org/dev/release.html]
+* [Signing Releases|http://apache.org/dev/release-signing.html]
+* [Wendy's notes on Release Signing|http://wiki.wsmoak.net/cgi-bin/wiki.pl?ReleaseSigning]
+* Apache [Mirroring Guidelines|http://apache.org/dev/mirrors.html]
+* Struts [Release Instructions|http://cwiki.apache.org/WW/creating-and-signing-a-distribution.html] (upon which these instructions are based)
Added: openjpa/site/trunk/original.cwiki.content/running-openjpa-examples.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/running-openjpa-examples.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/running-openjpa-examples.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/running-openjpa-examples.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,37 @@
+h1. Running the OpenJPA Examples
+
+The examples are packaged so that they run after extracting the openjpa binary distribution. Running directly from the source tree may take some work (not documented here).
+
+# Build the openjpa binaries
+{code}
+$ mvn clean install
+{code}
+# extract the binary distribution to a temporary directory
+{code}
+$ cd openjpa-project/target/site/downloads/
+$ unzip -qq -d temp *binary*.zip
+$ cd temp/$openjpa-version/examples
+{code}
+# run the helloJPA sample
+{code}
+$ cd hellojpa
+$ ant
+$ cd ..
+{code}
+# run the relations sample
+{code}
+$ cd relations
+$ ant
+$ cd ..
+{code}
+# run the reversemapping sample
+{note}
+Currently only works on unix platforms
+{note}
+{code}
+$ cd reversemapping
+$ ant
+$ cd ..
+{code}
+
+
Added: openjpa/site/trunk/original.cwiki.content/running-the-sun-tck-for-jpa.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/running-the-sun-tck-for-jpa.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/running-the-sun-tck-for-jpa.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/running-the-sun-tck-for-jpa.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,23 @@
+h1. Running the Sun TCK for JPA
+
+Sun's Technology Compatibility Kit for JPA is available to OpenJPA committers (other TCKs are available to Apache committers in general).
+
+h2. Requesting access to the TCK
+
+# Review the section "Testing with TCKs" on the[Apache JCP participation page | http://www.apache.org/jcp/]
+# The OpenJPA project should request access (this has already been done).
+# Sign the [Apache NDA | http://www.apache.org/jcp/ApacheNDA.pdf] .
+# Send the signed form to Geir Magnusson Jr. [mailto:geirm@apache.org].
+ Per email with Geir a scan of the signed form is fine.
+# Geir will place a copy of the TCK in your private directory on people.apache.org.
+
+The most up to date and complete information can be found on the [Apache JCP participation page | http://www.apache.org/jcp/].
+
+h2. Once you have a copy of the TCK you can execute the TCK bucket in maven.
+# copy the tck to $\{user.home\}/.m2/privaterepos/jpa-1_0b-tck.zip
+# Enable the tck profile and run the integration-test maven goal :
+ {code}
+ $ mvn integration-test -Ptck-profile
+ {code}
+
+More information on running the TCK can be found in the pom file for the [tck module | http://svn.apache.org/repos/asf/openjpa/trunk/openjpa-integration/tck/pom.xml ]
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/runtime-enhancement.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/runtime-enhancement.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/runtime-enhancement.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/runtime-enhancement.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,25 @@
+The first runtime enhancement method is to provide a _javaagent_ when launching the JVM that OpenJPA is going run in.
+{code}-javaagent:<openjpa_jar_location>{code}
+
+For Eclipse, specify the above _javaagent_ value on the Run Configuration page.
+
+For ANT, provide the _javaagent_ value as a _jvmarg_ when launching an application. Below is a snippet that shows how to pass in the _javaagent_ when launching a Java SE application that uses OpenJPA.
+
+{code}
+ <path id="jpa.enhancement.classpath">
+ <pathelement location="bin"/>
+ <!-- lib contains all of the jars that came with the OpenJPA binary download -->
+ <fileset dir="lib">
+ <include name="**/*.jar"/>
+ </fileset>
+ </path>
+ ...
+ <target name="drive" depends="clean, build">
+ <echo message="Running test with run time enhancement."/>
+ <java classname="main.Driver" failonerror="true" fork="yes">
+ <jvmarg value="-javaagent:${openJPA-jar}"/>
+ <classpath refid="jpa.enhancement.classpath"/>
+ </java>
+ </target>
+{code}
+
Added: openjpa/site/trunk/original.cwiki.content/samples.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/samples.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/samples.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/samples.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,43 @@
+{excerpt:hidden=true}OpenJPA Examples{excerpt}
+
+h1. OpenJPA Examples
+
+This page provides samples for OpenJPA. For further information, the [documentation] provides comprehensive documentation on all aspects of configuring and using OpenJPA. A [template|openjpa:SampleTemplate] is provided to describe how to build, deploy and run the samples. The existing samples will be reformatted to fit the template. If you are
+creating new samples, please adhere to the template.
+
+For more information on using OpenJPA within a Java EE application server, please see the [Integration] page for more details.
+
+* [Open JPA Basic Sample and tutorial|openjpa:Begin using OpenJPA - The Basics]
+* [OpenTrader - a transactional web application featuring how to integrate Google Web Toolkit and OpenJPA |openjpa:OpenTrader]
+* [OpenBooks - a end-to-end example featuring new JPA 2.0 features in JSE and JEE environments |openjpa:OpenBooks - Featuring JPA 2.0]
+* [Using Criteria API in DayTrader]
+* [Bean Validation Primer - A simple example which demonstrates the use Bean Validation with OpenJPA|openjpa:Bean Validation Primer]
+
+h2. OpenJPA ANT Examples
+
+These are some short (5 minutes) quick start guides for OpenJPA using the examples provided with the distribution. Most OpenJPA releases require Java SE 5, but see [Build and Runtime Dependencies] for more details.
+
+* [Getting Started]
+* [Embeddable samples]
+
+
+
+h2. Other Examples
+
+h3. Apache TomEE Examples
+
+* [Injection via @PersistenceContext|http://tomee.apache.org/examples-trunk/injection-of-entitymanager/README.html]
+* [JPA and Enums via @Enumerated|http://tomee.apache.org/examples-trunk/jpa-enumerated/README.html]
+* [JPA, UserTransaction and Rollback|http://tomee.apache.org/examples-trunk/transaction-rollback/README.html]
+
+All the above examples are standalone projects, contain unit tests and working maven pom.xml files. Examples are run with every build and release of [TomEE|http://tomee.apache.org].
+
+h3. Apache Geronimo v2.1 Samples
+
+* [Bean Managed Persistence with JPA|http://cwiki.apache.org/GMOxDOC21/bean-managed-persistence-with-jpa.html]
+* [Container Managed Persistence with JPA|http://cwiki.apache.org/GMOxDOC21/container-managed-persistence-with-jpa.html]
+* [Working with JSF and JPA|http://cwiki.apache.org/GMOxDOC21/working-with-jsf-and-jpa.html]
+* [Using Java Persistence API in application client|http://cwiki.apache.org/GMOxDOC21/using-java-persistence-api-in-application-client.html]
+* [Apache DayTrader Sample|http://cwiki.apache.org/GMOxDOC20/daytrader.html]
+
+\\
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/sampletemplate.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/sampletemplate.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/sampletemplate.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/sampletemplate.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,45 @@
+h1. A template for OpenJPA Samples
+
+h2. Introduction
+
+ A paragraph describing the basic purpose of the presented sample. In general, the purpose of a sample could be, but not limited to,
+ * to highlight some new feature introduced in a release (e.g. Bean Validation or Criteria API)
+ * to describe wiring between frameworks e.g. JSF and JPA, GWT and JPA
+ * to demonstrate operation within a container e.g. OSGi, Spring, Tomcat or JEE
+ * a combination of the above
+
+For example,
+ "this sample demonstrates usage of new Bean Validation API in a multi-tier web application"
+or "this sample integrates client-side Google Web Toolkit architecture with sever-side JPA application".
+ The functional features of the samples such as "This OpenBooks example can be used to place order and browse books" -- are not that important in this context but can be mentioned.
+
+h2. Installation
+
+ State the availability of the sample. For example,
+
+ * Is the distribution available as a downloadable archieve? If packaged in an archieve, all source code, build instructions must be available in the distribution itself. A {{README.txt}} should be inside and outside the distribution.
+
+ * Is the sample to be checked out from code repository? In such cases, building the sample should be done with Ant or Maven. Prefer Ant to make the dependencies and steps more visible.
+
+ *The steps in this section should be clear and concise for an user to follow them to build, deploy and run the sample.*
+
+
+h2. Environment
+
+ Enumerate the software artifacts required to build, deploy and run the sample. The artifacts should be categorized into build time and run time dependencies.
+
+h2. Configuration
+
+ Often building a sample will require the user to configure dependencies (such as OpenJPA libraries or JDBC Driver), for his/her local environment.
+The ANT build scripts for a sample must accept configurable properties via {{build.properties}} or similar configurable mechanics. The properties configuration file itself should be documented to explain the dependencies and how the build script use them. Maven based build scripts can make these dependencies more implicit and saves the user to explicitly satisfy such dependencies. However, ANT based builds are preferred over Maven for the samples, so that the build steps and dependencies are made more visible to the user.
+
+h2. Best Practices
+
+ The samples, besides demonstration of a feature, are a suitable vehicle of showing good development practices in JPA application programming model such as persistent domain modeling or architectural practices. It is recommended that such best practices be mentioned in several places:
+ * in the source code
+ * build scripts
+ * a separate document that enumerates them in one place.
+
+h2. Caveats
+
+ The complete develop-build-run cycle of a sample will often bring out the special considerations. For example, reported common errors in deployment in a container and their remedies or certain undesirable usage patterns. The description of a sample should highlight these special considerations rather than making the exercise appear as a series of perfectly easy steps. The caveats can be further highlighted by linking them to relevant JIRA issues or forum discussions or external blogs etc.
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/sidenav-community.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/sidenav-community.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/sidenav-community.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/sidenav-community.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,8 @@
+- [Events and News]
+- [Found a Bug]?
+- [Get Involved]
+- [Mailing Lists]
+- [Committers]
+- [Integration]
+- [Powered By]
+- [Thanks]
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/sidenav-development.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/sidenav-development.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/sidenav-development.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/sidenav-development.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,6 @@
+- [Issue Tracker|http://issues.apache.org/jira/browse/OPENJPA]
+- [Source Code]
+- [Testing]
+- [Tools]
+- [Samples]
+- [Release Management]
Added: openjpa/site/trunk/original.cwiki.content/sidenav-overview.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/sidenav-overview.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/sidenav-overview.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/sidenav-overview.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,6 @@
+- [Quick Start]
+- [Documentation]
+- [Downloads]
+- [Site Index]
+- [License]
+- [Privacy Policy]
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/sidenav-quick-links.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/sidenav-quick-links.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/sidenav-quick-links.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/sidenav-quick-links.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,5 @@
+- [Home|Index]
+- [License]
+- [ASF|http://apache.org]
+- [Downloads]
+- [Site Map]
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/sidenav.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/sidenav.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/sidenav.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/sidenav.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,26 @@
+h3. [Overview]
+
+{include:openjpa:SideNav Overview}
+
+h3. [Community]
+
+{include:openjpa:SideNav Community}
+
+h3. [Development]
+
+{include:openjpa:SideNav Development}
+
+h3. Search
+
+{html}
+<DIV style="padding: 5px 5px 0px 25px;">
+<FORM action="http://www.google.com/search" method="get" style="font-size: 10px;">
+<INPUT name="ie" type="hidden" value="UTF-8"></INPUT>
+<INPUT name="oe" type="hidden" value="UTF-8"></INPUT>
+ <INPUT maxlength="255" name="q" size="15" type="text" value></INPUT><BR></BR>
+ <INPUT name="btnG" type="submit" value="Google"></INPUT>
+ <INPUT name="domains" type="hidden" value="openjpa.apache.org"></INPUT>
+ <INPUT name="sitesearch" type="hidden" value="openjpa.apache.org"></INPUT>
+</FORM>
+</DIV>
+{html}
Added: openjpa/site/trunk/original.cwiki.content/site-index.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/site-index.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/site-index.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/site-index.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1 @@
+{index}
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/site-map.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/site-map.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/site-map.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/site-map.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1 @@
+{children:page=/|all=true|excerpt=true}
\ No newline at end of file
Added: openjpa/site/trunk/original.cwiki.content/source-code.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/source-code.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/source-code.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/source-code.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,39 @@
+{excerpt:hidden=true}Source code access{excerpt}
+
+h1. Source Code
+
+OpenJPA uses [Subversion|http://subversion.apache.org/] to manage its source code. Instructions on Subversion use can be found [here|http://svnbook.red-bean.com].
+
+h3. Web Access
+
+The source code for OpenJPA can be freely browsed at [http://svn.apache.org/viewvc/openjpa/]. The source code can also be searched and browsed using Cenqua's FishEye product at [http://fisheye6.cenqua.com/browse/openjpa].
+
+h3. Anonymous access
+
+OpenJPA source can be checked out anonymously with this command:
+
+{noformat}
+$> svn checkout http://svn.apache.org/repos/asf/openjpa/trunk openjpa
+{noformat}
+
+
+h3. Developer Access
+
+Everyone can access the OpenJPA Subversion repository via HTTPS, but OpenJPA Committers must checkout the Subversion repository via HTTPS in order to make updates, which will prompt for your ASF uid/pwd.
+
+{noformat}
+$> svn checkout https://svn.apache.org/repos/asf/openjpa/trunk openjpa
+{noformat}
+
+
+h1. Compiling Source
+
+Once you've got the code you'll probably want to build it; for instructions see [Building].
+
+We also have [Automated Builds] setup for several branches of OpenJPA.
+
+
+h1. Source Coding Standards
+
+The community has agreed upon some common code formatting standards, which we request that everyone follows when contributing patches and checking in changes to the svn repository. Some of these are enforced during the build, like 120 character line length by using the Checkstyle plugin and checking for required ASL 2.0 source headers by using the apache-rat plugin. Please checkout the [Coding Standards] page for more details.
+
Added: openjpa/site/trunk/original.cwiki.content/testing.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/testing.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/testing.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/testing.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,151 @@
+{excerpt:hidden=true}Running and [Writing|Writing Test Cases For OpenJPA] OpenJPA unit tests{excerpt}
+
+h1. Running and [Writing|Writing Test Cases For OpenJPA] Tests with OpenJPA
+
+OpenJPA's unit tests are written using JUnit. For a template for a simple test case, see the code for [TestPersistence.java|http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/simple/TestPersistence.java?view=markup].
+
+If you want to contribute your own test case then follow the [guidelines|Writing Test Cases For OpenJPA].
+
+Once you have downloaded and built OpenJPA (see [Building]), you can run individual tests using the "test" goal to maven. For example:
+
+{code}mvn test -DfailIfNoTests=false -Dtest=TestPersistence{code}
+
+{note} By default Maven will fail if there are no testcases found in any module you build. The examples solve this by specifying -DfailIfNoTests=false but you can also change your personal default by adding the following to $\{user.home\}/.m2/settings.xml :
+{code:xml}
+ <profile>
+ <id>enable-no-tests</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <properties>
+ <failIfNoTests>false</failIfNoTests>
+ </properties>
+ </profile>
+{code}
+{note}
+
+To get more debugging information (e.g., to see the SQL that is being executed against the database), you can enable trace-level logging from the command line using the "openjpa.Log" system property. For example:
+
+{code}
+$ mvn test -DfailIfNoTests=false -Dtest=TestPersistence -Dopenjpa.Log=DefaultLevel=TRACE
+
+[INFO] Scanning for projects...
+[INFO] Reactor build order:
+...
+690 test TRACE [main] openjpa.jdbc.SQL - <t 4261185, conn 3061987> executing prepstmnt 12659709
+ INSERT INTO AllFieldTypes (id, arrayOfStrings, booleanField, byteField, charField, dateField,
+ doubleField, floatField, intField, longField, shortField, stringField)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?) [params=(long) 601, (null) null, (int) 0, (byte) 0,
+ (int) 0, (null) null, (double) 0.0, (float) 0.0, (int) 0, (long) 0, (short) 0, (null) null]
+701 test TRACE [main] openjpa.jdbc.SQL - <t 4261185, conn 3061987> [11 ms] spent
+701 test TRACE [main] openjpa.jdbc.JDBC - <t 4261185, conn 3061987> [0 ms] commit
+702 test TRACE [main] openjpa.jdbc.JDBC - <t 4261185, conn 0> [0 ms] close
+...
+$
+{code}
+
+h2. Setting additional Log parameters
+
+There are several parameters that are used by OpenJPA Log. Here are some that might be of value when debugging test cases. Note that the logger names are case sensitive while the log levels are not.
+
+* DefaultLevel sets the level for all loggers that are not otherwise set
+* file sets the file name for logging output
+* Enhance logs messages from the enhancer
+* Metadata logs messages from the metadata processor
+* Tool logs messages from the schema synchronization tool
+* SQL logs messages from the SQL generator
+* JDBC logs messages related to JDBC
+* Schema logs messages related to schema
+* Runtime logs messages related to runtime
+* Query logs messages related to queried
+* DataCache logs messages related to caching
+
+Log levels specify the minimum log message that is output. All log messages with a level higher than the log level set for a logger are output. So if INFO is specified, log messages of level INFO, WARN, ERROR, and SEVERE are output.
+
+* TRACE
+* INFO
+* WARN
+* ERROR
+* FATAL
+
+For example, to avoid enhancement warnings, get detailed SQL information, and write the log data to a file:
+
+{code}mvn test -Dtest=TestPersistence -Dopenjpa.Log=Enhance=ERROR,SQL=TRACE,file=openjpa.log{code}
+
+h1. Testing against alternate databases
+
+By default, OpenJPA uses the [Derby|http://db.apache.org/derby/] database for testing. The {{openjpa-persistence-jdbc/pom.xml}} POM declares various pre-defined databases against which tests can be executed. For example, to test against the stand-alone [HSQLDB|http://hsqldb.org/] database, you can run with the "test-hsqldb" profile:
+
+{code}mvn test -DfailIfNoTests=false -Dtest=TestPersistence -Ptest-hsqldb{code}
+
+For databases that are not in the pre-defined list, you can manually specify connection parameters to use for testing under the "test-custom" profile. You will need to manually provide the driver class and specify all of the connection parameters. For example, to test against Oracle, you might run:
+
+{code}
+mvn test -DfailIfNoTests=false -Dtest=TestPersistence -Ptest-custom \
+ -Dopenjpa.custom.driverjar=$(pwd)/drivers/jdbc-oracle-10_2_0_1_0.jar \
+ -Dopenjpa.custom.driverclass=oracle.jdbc.driver.OracleDriver \
+ -Dopenjpa.custom.url=jdbc:oracle:thin:@HOST:PORT:DBNAME \
+ -Dopenjpa.custom.username=USERNAME \
+ -Dopenjpa.custom.password=PASSWORD
+{code}
+
+If you frequently need to test against another database, you can permanently declare the database connection parameters in the {{~/.m2/settings.xml}} file under a custom profile. For example:
+
+{code}
+<settings>
+ <profiles>
+ <profile>
+ <id>test-oracle</id>
+ <properties>
+ <test-custom>true</test-custom>
+ <openjpa.custom.driverjar>${user.home}/.m2/privaterepos/jdbc-oracle-10_2_0_1_0.jar</openjpa.custom.driverjar>
+ <openjpa.custom.driverclass>oracle.jdbc.driver.OracleDriver</openjpa.custom.driverclass>
+ <openjpa.custom.url>jdbc:oracle:thin:@HOST:PORT:DBNAME</openjpa.custom.url>
+ <openjpa.custom.username>USERNAME</openjpa.custom.username>
+ <openjpa.custom.password>PASSWORD</openjpa.custom.password>
+ </properties>
+ </profile>
+ </profiles>
+</settings>
+{code}
+
+This profile can then be executed by running:
+
+{code}
+mvn test -DfailIfNoTests=false -Dtest=TestPersistence -Ptest-custom,test-oracle
+{code}
+
+
+h1. Running JUnits in Eclipse
+
+You'll probably want to setup a Debug Configuration in Eclipse for running the JUnit testcases.
+
+# Run --> Debug Configurations... Create a new JUnit configuration
+!eclipse_dbgcfg_1.png|border=1!
+# For the Test tab - Give the configuration a Name, select a Project and Test class, and you'll probably want to select the "Keep JUnit running..." option.
+!eclipse_dbgcfg_2.png|border=1!
+# For the Arguments tab - Press the Variables... button. This will allow us to define variables that can be shared across other Release/Debug Configurations within this workspace.
+!eclipse_dbgcfg_3.png|border=1!
+# For the Select Variable window - Press the Edit Variables... button.
+!eclipse_dbgcfg_4.png|border=1!
+# For the Preferences windows - Press New... to add two variables.
+!eclipse_dbgcfg_5.png|border=1!
+{code}
+Name = openjpa.trace
+Value = -Dopenjpa.Log=DefaultLevel=TRACE
+Description = Set OpenJPA logging to TRACE
+{code}
+!eclipse_dbgcfg_6.png|border=1!
+{code}
+Name = connect.derby
+Value = -Dopenjpa.ConnectionDriverName=org.apache.derby.jdbc.EmbeddedDriver -Dopenjpa.ConnectionURL=jdbc:derby:target/database/openjpa-derby-database;create=true
+Description = Connection properties for Derby
+{code}
+!eclipse_dbgcfg_7.png|border=1!
+# After the above are created and saved, add the new variables as VM Arguments.
+{code}
+${openjpa.trace}
+${connect.derby}
+{code}
+!eclipse_dbgcfg_8.png|border=1!
+
Added: openjpa/site/trunk/original.cwiki.content/thanks.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/thanks.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/thanks.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/thanks.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,34 @@
+{excerpt:hidden=true}Thanks to helpful people and organizations {excerpt}
+The Apache OpenJPA team would like to thank the following individuals and organizations.
+
+h2. Apache Sponsors
+Without those sponsors, the ASF would simply not exist or sustain its activities :
+[http://www.apache.org/foundation/thanks.html]
+
+For those who want to know more about the Apache Sponsorship Program, please check :
+[http://www.apache.org/foundation/sponsorship.html]
+
+Thanks !
+
+h2. Individuals who helped our project . . .
+
+
+h3. Website Design
+
+Marc Prud'hommeaux - Wiki template design based on [Apache ActiveMQ|http://activemq.apache.org/] template.
+
+h3. OpenJPA Logo
+
+Please visit the [Logo Contest] page for all of the submitted entries...
+
+
+h2. Organizations who helped our project . . .
+
+||Organization || Donation type || Organization Contact || Apache Contact ||
+| [ej-technologies|http://www.ej-technologies.com] | [jProfiler|http://www.ej-technologies.com/products/jprofiler/overview.html] license | Hannes Kegel, CTO | Pinaki Poddar |
+
+
+h2. Related Projects
+Other [Related Projects] that OpenJPA depends upon or uses.
+
+\\
Added: openjpa/site/trunk/original.cwiki.content/tools.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/tools.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/tools.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/tools.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,28 @@
+h1. Tools for OpenJPA
+
+This page will host description of design-time and runtime tools for OpenJPA.
+The tools mentioned below are available as command-line utilities. In the future, they may be made available as interactive graphical tools integrated into popular IDEs such as Eclipse or IntelliJ.
+
+h3. Existing OpenJPA Tools
+
+The OpenJPA distribution and runtime already comes with a series of useful tools to:
+
+* [Entity Enhancement] for enhancing the bytecode of POJO domain classes
+* [reverse map|http://openjpa.apache.org/builds/latest/docs/docbook/manual.html#ref_guide_pc_reverse] a database schema to Java source code
+* [create/synchronize|http://openjpa.apache.org/builds/latest/docs/docbook/manual.html#ref_guide_mapping_mappingtool_examples] a Java persistent domain model to a database schema
+* [generate|http://openjpa.apache.org/builds/latest/docs/docbook/manual.html#d0e11103] canonical metamodel classes for strictly-typed Criteria queries
+
+
+h3. Tools Under Development
+
+A new OpenJPA Tools subproject has been created to deliver a new set of tools that are decoupled from a specific OpenJPA release.
+* [Migration Tool] - translates proprietary mapping descriptors (such as Hibernate) to standard JPA mapping descriptors.
+* [Entity enhancer for Eclipse|OpenJPAEclipseInstallation] provides a plugin which can be used to pre-enhance your entities when building in Eclipse.
+* [Domain Model Browser]
+* [JConsole DataCache Plugin] - JConsole plugin to monitor openjpa.DataCache usage.
+* [Fetch Statistics] - monitors persistent field access and determines which fields are never used.
+
+
+\\
+
+\\
Added: openjpa/site/trunk/original.cwiki.content/top-navigation-bar.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/top-navigation-bar.cwiki?rev=1415738&view=auto
==============================================================================
(empty)
Added: openjpa/site/trunk/original.cwiki.content/update-release-text-files.cwiki
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/original.cwiki.content/update-release-text-files.cwiki?rev=1415738&view=auto
==============================================================================
--- openjpa/site/trunk/original.cwiki.content/update-release-text-files.cwiki (added)
+++ openjpa/site/trunk/original.cwiki.content/update-release-text-files.cwiki Fri Nov 30 16:56:02 2012
@@ -0,0 +1,39 @@
+{excerpt:hidden=true}Instructions for updating .text files shipped with OpenJPA{excerpt}
+
+h1. Updating release text files.
+
+
+h2. Obtaining the list of resolved issues from JIRA.
+
+# Go to the main JIRA releases page at [http://issues.apache.org/jira/browse/OPENJPA?report=com.sourcelabs.jira.plugin.portlet.releases:releases-projecttab]
+# Under Unreleased find the version you're about to release and click on "Release Notes".
+Keep this page open since it contains a nice reference point for many of the documents you will edit.
+
+h2. Update text files
+
+* openjpa-projects/CHANGES.txt
+## Update the overview paragraph with the new version and a brief description of the release.
+## Remove the previous changes section and replace with a url to the location in SVN. _This is similar to what HTTPD does in its CHANGES file_
+## Create a new section : OpenJPA x.y.z changes and copy the JIRA issues resolved in this section. You may want to do some minor editing by hand to ensure the file respects the 80 character column width guideline.
+* openjpa-project/RELEASE-NOTES.html
+## Similar to CHANGES.txt you need to update the version number and provide a brief description of the release.
+## Remove the previous list of changes for the previous release. Replace this with a link to the last release's file in SVN.
+## Add a new section. This can be copied from the JIRA page with one exception (see the next step).
+## Update the links at the top of the file. If you've copied changes from JIRA you'll see a section like this :
+{code}
+<h2> Bug
+</h2>
+{code}
+Replace it with
+{code}
+<h4><a name='Bug'>Bug</h4>
+{code}
+You should also check the links at the top to make sure they are all valid.
+* openjpa-project/NOTICE.txt
+NOTICE.txt "usually" does not need to be updated. The exceptions are when a new dependency has been introduced (ie a new version of Serp) or if a new source file containing a copyright notice is introduced.
+* openjpa-project/LICENSE.txt
+Similar to NOTICE.txt this file does not require updating in each release. It should contain the current version of the Apache license, and any other licenses mentioned in NOTICE.txt.
+* openjpa-project/README.txt
+This file rarely needs updating - just make sure the URL is accurate.
+* openjpa-project/BUILDING.txt
+This file rarely needs updating.