This page is a guide, to making a release for the BookKeeper project. It's based off the Whirr instructions and our experience releasing.
There are a few things which you need to set up before making a release.
You should have a 4096 bit RSA PGP key for signing the release. This key should be in the Apache web of trust. Once generated, ensure your key is in https://svn.apache.org/repos/asf/bookkeeper/dist/KEYS.
Put the following in ~/.m2/settings.xml. This will allow you to release and deploy to the apache maven repositories. Of course, it's best not to store your password in cleartext. See http://maven.apache.org/guides/mini/guide-encryption.html for a guide on how to make this a little more secure.
SSH setup on people.apache.org
The release procedure will require multiple logins to people.apache.org. To avoid having to log in many times, ensure that you have ssh password less login set up for people.apache.org.
Making the release
The steps for releasing are as follows.
- Create release branch
- Generate release notes
- Build and stage artifacts
- Inspect the artifacts
- Tag the release in Subversion
- Run the vote
- If vote gets +1 from 3 PMC members and no -1, go to next step, otherwise fix problem and repeat from step 2.
- Release artifacts
- Wait 24 hours for mirrors to sync
- Update the website
- Announce the release
Creating the release series branch (NEEDS UPDATE)
This only needs to be done for the first release of a series, (e.g. It needs to be done for 4.1.0 but not for 4.1.1 or 4.1.2).
- Update CHANGES.txt, renaming the trunk section to reflect the version being released.
Create a branch for the release:
Check out the new branch.
- Update the version in all pom files. X.Y.0-SNAPSHOT -> X.Y.0
- Commit these changes.
- Add a new trunk section in CHANGES.txt
- Bump the version in all poms, X.Y.0-SNAPSHOT -> X.(Y+1).0-SNAPSHOT
Generate release notes
Generate the release notes from JIRA. https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311293
Select the correct version, in HTML format. Make it look like previous release notes. https://svn.apache.org/repos/asf/bookkeeper/site/content/docs/r4.1.0/releaseNotes.textile
Generate a list of all issues committed since last release. In this example, the last release was release-4.2.3, so we want to see all changes since that tag.
Manually check that the list from JIRA, GIT and CHANGES.txt all reflect the same changes.
Update CHANGES.txt using the JIRA release notes in text format.
Build the artifacts
Make sure the branch builds cleanly. Check for errors and warnings in the output.
Then build the artifacts.
This will generate
Inspect the artifacts
Extract each of the generated artifacts;
- Check file permissions are correct for all files
- Check the LICENSE and NOTICE files cover all included jars (especially for the -bin packages)
- Check the source package builds, and all tests pass
- Check that "mvn apache-rat:check" passes on the source package.
- Check that a bookie can be run from the source package and from the bookkeeper-server binary package
- Check that a hedwig hub can be run from the source package and from the hedwig-server binary package
Staging the artifacts
Create a directory and copy the three tar.gz packages into it. Sign and generate md5 & sha1 hashes for each package.
Add these files to a directory in https://dist.apache.org/repos/dist/dev/bookkeeper (this is a subversion repo), naming it bookkeeper-<VERSION>-candidate-0.
... and into Maven
This will ask for your gpg passphrase.
Login to https://repository.apache.org using your Apache SVN credentials. Click on Staging on the left. Then click on org.apache.bookkeeper in the list of repositories. In the panel below you should see an open repository that is linked to your username and IP. Select this repository and click Close. This will close the repository from future deployments and make it available for others to view.
Tag the release
Commit changes to git, tag, and push:
Run the vote
Send a mail like the following, updating the relevant content.
Release the artifacts
Move the release candidate into the release directory in subversion, stripping the candidate part from its name.
Remove the old releases from the release directory in subversion (we only need the latest release there, older releases are available through the archive):
Release the repository in maven. Log in to https://repository.apache.org, click on Staging on the left. Select the repository that you closed earlier, and click Release, using a description like "Apache BookKeeper X.Y.Z artifacts". This will make the artifacts publicly available.
Update the website
See Building the website and documentation. Follow the pattern used for previous releases. Add the documentation for the release, the release notes, and link in the releases page and an update in the new page.
Announce the release (NEEDS UPDATE)
Assuming 24 hours have passed since releasing the artifacts, send a mail like the following.