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
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:
- 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 the latest Java 1.6.x JDK installed and on your shell's path. See http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase6-419409.html
- you have set the environment variable MAVEN_OPTS=-Xmx512m
- you are using Maven 3.2.x. See http://maven.apache.org/
Make sure maven uses Java 7
Although Empire-db is compatible with Java 6 we are ruilding Releases using JDK 7 in order to avoid certificate issues.
Java 8 or later have not been tested and approved.
The build process has been performed using Maven 3.3.9.
If Java 8 or later is installed on the machine, possibly create a mvn7 shell script and add it to your PATH in order to be able to use Java 7 to build the release.
test the script by running this command:
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.
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:
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
Close the staging repository
- Go to: https://repository.apache.org and
- log in
- Select "Staging repositories"
- Find the newly created repository and select "Close"
Follow the steps as described on http://maven.apache.org/developers/release/releasing.html (Close the staging repository)
Create Distribution checksums
The distribution files are now located in target/checkout/empire-db-dist
In order to create the checksums use:
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
For Windows you might want to use the "File Checksum Integrity Verifier" (fciv).
fciv -md5 -wp target\apache-empire-db-2.4.6-dist.zip > target\apache-empire-db-2.4.6-dist.zip.md5
fciv -sha -wp target\apache-empire-db-2.4.6-dist.zip > target\apache-empire-db-2.4.6-dist.zip.sha
Upload the Distribution
Finally upload the generated files + rat report to the distribution directory using svn.
as explained here: http://www.apache.org/dev/release#upload-ci
Initiate a vote
The vote mail should look like this:
Subject: [VOTE] Release Apache Empire-db 2.0.5 (rc3)
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:
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
- 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.4.4-rc1 -> apache-empire-db-2.4.4
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 firstname.lastname@example.org:~/public_html/empire-db/apache-empire-db-* .
- remove old releases:
www.apache.org/distshould contain only the latest release
- commit to the subversion repo
- Wait 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 or update the Empire-db website source files from
svn checkout 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.
- Make sure the links to previous versions point tot the archive
- In downloads/latest.htm replace all references to the old version number with new version number.
- Update news.html
- do a svn delete on javadocs/empire-db
- recreate the empire-db folder
- fetch the new javadoc jar from http://repo1.maven.org/maven2/org/apache/empire-db/empire-db/x.x.x/empire-db-x.x.x-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.
Send an E-Mail to email@example.com
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 firstname.lastname@example.org and email@example.com 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/
Main improvements listed below:
[add description and list of changes]
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...