A distribution (release) of JDO is built from a branch of git. A release consists of a compressed source (e.g. zip file) and associated checksums and signatures. It is copied into a release directory, from which it is staged and tested. Once approved by a formal vote of the DB PMC, it is copied to the officiel Apache distribution infrastructure and propagated to mirror servers around the world.
The process is performed by a release manager with cooperation from testers in the community.
The community first decides on the name of the release. The format of the name is spec-number.major.minor. A trailing minor number with a zero value is right trimmed, so there might be a 3.0.1 but not a 3.0.0.
Interim releases prior to final release are identified by a suffix on the release number. Common suffixes include: -alpha, -beta, -beta2, -rc1, -rc2. Generally, the suffixes are part of the release plan, and the contents of each suffix release are agreed by the community. There might be significant changes in functionality between the suffix releases. Each suffix release goes through the process documented here.
The community decides whether to continue development on the main branch while the release is in progress. In this case, a branch is created first. If a new branch is needed, the release manager makes a new branch from the main branch (for a major release) or from another branch (for a minor release). If a new branch is not needed, the release will be created from the main branch and a release branch will only be created later for a maintenance release.
The release manager follows the Apache process detailed below to build and deploy a release.
The release manager calls for the community to test the release.
The community tests the release. If necessary, cycle until all issues are resolved.
The release manager closes the staging repository
The release manager calls for a vote to release by sending a message to the community and forwarding the message to the PMC.
The community votes on the release. If necessary, cycle until issues are resolved.
The release manager notifies the PMC of the successful vote outcome. A successful vote includes three +1 votes from PMC members and more +1 than -1 votes. The release manager copies the approved release to the official Apache distribution directory which is then mirrored worldwide.
The release manager notifies the worldwide community of the availability of the release.
The release manager updates the JDO web sites (http://db.apache.org/jdo/index.html, http://java.sun.com/jdo/).
If bugs are found or test challenges are sustained after the release is approved and distributed, the release manager creates a new branch to address the bugs found and proceeds from the beginning.
Verify licensing of the sources by running Apache Rat to check the sources for any licence issues.
mvn clean apache-rat:check
If necessary, create a branch from the main branch and increment the spec or major number. For example, create a “3.1” branch from the main branch.
git checkout -b 3.2 git push -u 3.2
In the release branch, update version numbers in the following files in preparation for the next release:
tck/README.md
Update version number and date
Use the maven version plug-in to update version numbers in the pom.xml files at the root and subproject levels.
If needed, update the dependency to the RI, DataNucleus, in the tck pom.xml.
If needed, apply patches from the main branch to the release branch.
Update version numbers where necessary in projects to be released, if these changes haven't been made previously. Check the following files: README.md
File names and version references in the Overview section (for a major release only.)
tck/RunRules.md
Update version number
Check the scm settings in the pom.xml files in the new branch and make sure they refer to the new branch (instead of the main branch).
Follow the instructions at Publishing Maven Artifacts to set up your development environment.
Copy the JNDI implementation jars (providerutil.jar and fscontext.jar) to the branch lib/ext directory. This is needed to test the tck before distributing it. Do not check these in into the repository
Make sure the TCK passes
mvn clean install
Build the distribution with the following command:
mvn clean install -Papache-release -Djdo.tck.doRunTCK=false -Djdo.tck.doInstallSchema=false -Djdo.tck.doEnhance=false
This creates the .jar and .pom files in the target directory of each subproject. Be prepared to enter your key passcode when prompted, to create the .asc GPG signatures. This happens multiple times.
Run Apache Rat on the release artifacts to verify the results of the build.
Download Apache Rat from https://creadur.apache.org/rat/download_rat.cgi and extract the Jar-File, e.g. apache-rat-0.13.jar
java -jar apache-rat-0.13.jar -E .rat-excludes -d api/target/jdo-api-3.2-SNAPSHOT-sources.jar java -jar apache-rat-0.13.jar -E .rat-excludes -d tck/target/jdo-tck-3.2-SNAPSHOT-sources.jar
Do a dry run prepare and deployment of a snapshot release. You might want to do this in a fresh workspace, since you cannot have local modifications when preparing a release. The files in lib/ext and lib/jdori count as local modifications. Be prepared to enter your key passcode when prompted. This happens multiple times.
The release plugin will will ask the following questions and expects an input: What is the release version for “JDO Root POM”? What is the SCM release tag or label for “JDO Root POM”? What is the new development version for “JDO Root POM”? The proposed defaults should be fine.
mkdir tmp cd tmp git clone https://github.com/apache/db-jdo.git cd db-jdo mvn release:prepare -Papache-release -DautoVersionSubmodules=true -DdryRun=true -Dresume=false mvn deploy -Papache-release
Check the artifacts at the Maven release repository
Prepare and release the artifacts. There are interoperability issues with the maven release plugin and cygwin, so if on Windows, use a Windows command window for this step and the following one.
mvn release:clean -Papache-release mvn release:prepare -Papache-release
Stage the release for a vote.
mvn release:perform -Papache-release
Go to the Nexus repository, login with your apache account, click on Staging Repositories in the menu on the left and close the staged repository. Press the refresh button to see the new status ‘closed’. See Closing an Open Repository for details.
Send an announcement (e.g. Subject: Please test staged JDO 3.2 release) to test the release to the jdo-dev@db.apache.org alias. If problems are found, fix and repeat.
Send an announcement to vote on the release to the jdo-dev@db.apache.org alias. The message subject line contains [VOTE]. Forward the [VOTE] message to private@db.apache.org. Iterate until you get a successful vote. Mail the results of the vote to jdo-dev@db.apache.org, cc: general@db.apache.org, and include [VOTE] [RESULTS] in the subject line.
After testing and voting is complete, follow the instructions at Releasing a Staging Repository to release the artifacts.
Update the distribution repository at https://apache.org/dist/db/jdo/ by adding the new release directory. Check out the SVN repository at https://dist.apache.org/repos/dist/release/db/jdo and add the new release with all artifacts under the new directory. Make sure that the key used to sign the artifacts is included in the KEYS file. Committing the new directory will trigger an update to the mirrors.
After updating the site (below), announce the release to the Apache community via email to announce@apache.org This must be sent from an @apache.org email address. Be aware that by sending to this address you will be bombarded with piles of emails from people with “I'm out of the Office” as if you really cared.
Update the Apache JDO web site to point the downloads page to the release.
In dbo-jdo-site/src/main/asciidoc create release-N.n.adoc.
Edit db-jdo-site/src/main/asciidoc/downloads.adoc to link to the new release page .adoc document.
Build and test as described in the db-jdo-site/README.md document.
Change the link to RunRules on the TCK page to link to the RunRules.md file of the latest release.
Update the news list on the site home page to announce the new release.
Update the specification page to link to the new specification pdf document. If the release has been approved by the JCP, link to the documentation page of the JCP web site. If the release has not been approved by the JCP, link to the .pdf in the JDO source repository.
Add the javadoc for the release to the site.
git add on docsdir.Build and test. Follow the instructions in db-jdo-site/README.md to push the site changes to the Apache web site.
Follow this procedure if a significant bug is found or if the TCK must be modified because a test challenge is found to be valid.