How to cut a new Apache Empire-db release.

This document explains how to cut a new empire-db release. Since we normally do this in Linux I expect you to have a Linux enironment at hand. For windows users Cygwin might be a solution. This document is based on the Maven release documentation.

The general incubator release guide is available here: http://incubator.apache.org/guides/releasemanagement.html
but since we are out of incubation the docs are here: http://www.apache.org/dev/release
The apache central maven repo release guide is available here: http://www.apache.org/dev/publishing-maven-artifacts.html

The release process takes about one hour to perform, don't do this in a hurry as it is important to perform each step in the correct order!

Before you get started

Setup

Make sure your system is set up correctly and that you have the needed credentials

you have all Maven servers defined in your settings.xml. For more information, please refer to Committer settings. This is what mine looks like:

<?xml version="1.0"?>
<settings>
 <servers>
    <!-- To publish a snapshot of some part of Maven -->
    <server>
      <id>apache.snapshots.https</id>
      <username>francisdb</username>
      <password>xxx</password>
    </server>
    <!-- To publish a website of some part of Maven -->
    <server>
      <id>apache.website</id>
      <username>francisdb</username>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
    </server>
    <!-- To stage a release of some part of Maven -->
    <server>
      <id>apache.releases.https</id>
      <username>francisdb</username>
      <password>xxx</password>
    </server>
    <!-- To stage a website of some part of Maven -->
    <server>
      <id>stagingSite</id> <!-- must match hard-coded repository identifier in site:stage-deploy -->
      <username>francisdb</username>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
    </server>
</servers>

  <profiles>
    <profile>
      <id>apache-release</id>
      <properties>
        <gpg.passphrase>xxx</gpg.passphrase>
      </properties>
    </profile>
  </profiles>

</settings>

you have created your GPG keys. For more information, please refer to Making GPG Keys and http://www.apache.org/dev/release-signing.html .
you have a GPG client installed and on your shell's path. See http://www.gnupg.org/.
you have a Subversion 1.5+ client installed and on your shell's path. See http://subversion.tigris.org/.
you have a Java 1.4.2 JDK installed and on your shell's path. See http://java.sun.com/j2se/1.4.2/download.html.
you have set the environment variable MAVEN_OPTS=-Xmx512m
you are using Maven 2.0.x or 2.2.1+, as Maven 2.1.x is known to produce wrong gpg pom signatures (see MGPG-14).

Make sure maven uses Java 6

Download the latest JDK 6 http://www.oracle.com/technetwork/java/javase/downloads/jdk6-downloads-1637591.html

Create a mvn6 shell script and add it to your PATH. This script makes sure you use Java 6 to build the release.

/usr/bin/mvn6

#!/bin/sh
JAVA_HOME="/usr/lib/jvm/java-1.6.0-sun"
mvn $@

test the script by running this command:

>mvn6 --version
Apache Maven 2.2.1 (r801777; 2009-08-06 20:16:01+0100)
Java version: 1.6.0_33
Java home: /usr/lib/jvm/java-1.6.0-sun-1.6.0.33/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux" version: "2.6.28-15-generic" arch: "amd64" Family: "unix"

Make sure that the Java version is 1.6.x!

Creating a new RC

Update the changelog file

Edit CHANGELOG.txt in you favorite editor and add the closed issues for this release. Info can be exported from jira.

Go to: https://issues.apache.org/jira/browse/EMPIREDB/
In the versions due section go to the version you want to release
Click on release notes
Configure release notes to text
Copy the notes to our CHANGELOG.txt

Prepare the release

Make sure your code is up to date, builds, is available in your snapshot repository and has no local changes

You will be asked about the release versions. Make sure you enter a correct tag: apache-empire-db-[version]-rc[nr]. Once the release vote passes we can then copy this -rcX tag to the final version tag.

>mvn6 clean install
...
>mvn6 clean release:clean
...
>mvn6 release:prepare -Papache-release
...
[INFO] Checking dependencies and plugins for snapshots ...
What is the release version for "Apache Empire-db Parent"? (org.apache.empire-db:empire-db-parent) 2.0.5: : 
What is SCM release tag or label for "Apache Empire-db Parent"? (org.apache.empire-db:empire-db-parent) empire-db-parent-2.0.5: : apache-empire-db-2.0.5-rc3
What is the new development version for "Apache Empire-db Parent"? (org.apache.empire-db:empire-db-parent) 2.0.6-SNAPSHOT: : 
[INFO] Transforming 'Apache Empire-db Parent'...
[INFO] Updating empire-db to 2.0.5
...

INFO: If during this prepare you get some subversion related errors, try to do an "svn update" and calling "mvn release:prepare" again. This will then continue the release preparation from where it stopped. You might have to do this multiple times!

If anything goes wrong during the release you can do a rollback:

>mvn6 release:rollback

Also run a svn diff/revert to make sure your working copy is clean

Perform the release

This step will upload the artifacts the the staging repository

>mvn6 release:perform

Close the staging repository

Go to: https://repository.apache.org and log in
Follow the steps as described on http://maven.apache.org/developers/release/releasing.html (Close the staging repository)

Upload the distribution

TODO we might want to switch to https://dist.apache.org/repos/dist/dev/<TLP name>/
as explained here: http://www.apache.org/dev/release#upload-ci

>cd target/checkout/empire-db-dist (we want to have the same artifacts in the dist as in the repo)
>./checksums.sh
...
All Done. Files available in ./target

OR (if the previous failed/is not possible any more)

this might not work, not tested, probably creates new artifacts instead of using existing ones

>svn checkout https://svn.apache.org/repos/asf/empire-db/tags/apache-empire-db-2.0.5-rc3
...
>cd apache-empire-db-2.0.5-rc3/empire-db-dist/
>mvn6 clean install -Papache-release
>./checksums.sh
...
All Done. Files available in ./target

Now upload the generated files + rat report to your apache personal directory.

>cd target/
>scp * people.apache.org:~/public_html/empire-db

Now remove the .pom on the remote machine

>ssh people.apache.org
>rm public_html/empire-db/apache-empire-db*.pom*
>exit

Initiate a vote

Docs here: http://www.apache.org/dev/release#approving-a-release

The vote mail should look like this:

To: dev@empire-db.apache.org
Subject: [VOTE] Release Apache Empire-db 2.0.5 (rc3)

Hi,

We have just prepared a 2.0.5 release and we are now looking for approval of the PMC to publish the release.
More info on release requirements can be found here: http://www.apache.org/dev/release#approving-a-release

These are the major changes from our previous 2.0.4 release:

xxx

xxx

Changelog: http://svn.apache.org/viewvc/empire-db/tags/apache-empire-db-2.0.5-rc3/CHANGELOG.txt?view=co

Subversion tag: https://svn.apache.org/repos/asf/empire-db/tags/apache-empire-db-2.0.5-rc3

Maven staging repository: https://repository.apache.org/content/repositories/orgapacheempire-db-044/

Distribution files are located here http://people.apache.org/~francisdb/empire-db/

Rat report for the tag is available here: http://people.apache.org/~francisdb/empire-db/rat.txt

Vote open for 72 hours.

[ ] +1
[ ] +0
[ ] -1

Make sure you provide the correct paths!
Now wait for the vote to succeed.

Unsuccessful vote: roll back changes on trunk

Drop the staging repository in nexus
Update the local code

Use the maven versions plugin to roll back the version update

> mvn versions:set -DnewVersion=2.0.7-SNAPSHOT -Papache-release -DgenerateBackupPoms=false

Commit the project
Go to the create new RC step

Successful vote: Promoting the RC as release

Copy RC tag to release tag

Just use your prefered subversion tool to copy the rc tag to the final release tag
apache-empire-db-2.0.5-rc3 -> apache-empire-db-2.0.5

svn copy https://svn.apache.org/repos/asf/empire-db/tags/apache-empire-db-2.4.0-rc2 https://svn.apache.org/repos/asf/empire-db/tags/apache-empire-db-2.4.0

Promote the nexus staging files

Log in to nexus as described above,

Go to: https://repository.apache.org and log in
Follow the steps as described on http://maven.apache.org/developers/release/releasing.html
(go to the staging section, right click on the staged release and select release)

Set up new release in JIRA / close old one

Go to https://issues.apache.org/jira/browse/EMPIREDB
Click on Administer Project /Administration
Click on Manage versions
Release current version
Create new / edit versions if needed

Move the release files to the dist location

Docs here: http://www.apache.org/dev/release#upload-ci

svn checkout https://dist.apache.org/repos/dist/release/empire-db/ empire-db-dist-release
Create a subdirectory with the version number (i.e. 2.0.5)
Copy all distribution files from your apache home directory to that directory (.zip, .tar.gz, .asc, .md5, .sha)
scp francisdb@people.apache.org:~/public_html/empire-db/apache-empire-db-* .
commit to the subversion repo
Wait (one day) before files become available on the mirrors

Update the Empire-db website

this part needs an update as we are out of the incubator/snvpubsub

Check out the Empire-db website source files from https://svn.apache.org/repos/asf/empire-db/site
Update the doap_Empire-db.rdf file, add new version
Edit Pages with html editor (I am using Microsoft Expression Web)
Open page downloads/latest.htm and copy section with previous release files to downloads/previous.htm.
In downloads/latest.htm replace all reference to old version number with new version number.
Update news.html
so a svn delete on javadocs/empire-db
commit
recreate the empire-db folder
fetch the new javadoc jar from http://repo1.maven.org/maven2/org/apache/empire-db/empire-db/2.0.7/empire-db-2.0.7-javadoc.jar
extract into the javadocs/empire-db folder
svn add the empire-db folder
Commit all changes to svn repo.
Wait some time for changes to become available on the mirrors.
Remove all old releases from the https://dist.apache.org/repos/dist/release/empire-db/ subversion folder, only one (latest) release per branch allowed? TODO check if still needed

Announce release

Send an E-Mail to announce@apache.org

Important: The e-mail must be sent from an apache e-mail account. It is sufficient if the from address contains an apache mail account.
Put dev@empire-db.apache.org and user@empire-db.apache.org mailing lists in cc.

Start the mail as follows:

Subject: [ANNOUNCE] Apache Empire-db xxx released

The Apache Empire-db team is pleased to announce the release of Apache Empire-db version xxx.
Apache Empire-db is a lightweight data access and persistence component for relational databases based on JDBC. http://empire-db.apache.org/

[add description and list of changes]

Changelog: http://svn.apache.org/viewvc/empire-db/tags/apache-empire-db-xxx/CHANGELOG.txt?view=co

Download: http://empire-db.apache.org/downloads/latest.htm

Thank you for your interest in Apache Empire-db!

The Apache Empire-db Team.

Maybe send the release to some other sites as well (dzone) / do a blog post about it...

Child pages

Release Process