How to Release

(most of the content grabbed/adapted from MRUnit site)

First time release managers

  1. Generate PGP code signing keys
  2. Add the PGP code signing keys to the KEYS file as documented on the Infrastructure site
  3. Put in a Infrastructure JIRA asking to get added to the incubator unix group on people.apache.org
  4. Copy the modified KEYS file to the release folder /www/www.apache.org/dist/incubator/jspwiki on people.apache.org and ensure it has 0664 permissions.

It is convenient to setup the ssh keys on people.apache.org, otherwise you'll have to enter your login password a number of times.

Create a release candidate

  1. Generate release notes
  1. Deploy source and binary distributions

    1. Generate the src & bin distributions:

      ant clean signeddist
      
    2. Copy the src distribution file and checksums to people.apache.org, excluding the asc.md5/asc.sha1 files:

      scp target/*.tar.gz* username@people.apache.org:~/public_html/jspwiki-X.Y.Z-incubating-candidate-$RC
      
  1. Tag the release candidate:

    svn copy https://svn.apache.org/repos/asf/incubator/jspwiki/branches/jspwiki-X.Y/ \
    https://svn.apache.org/repos/asf/incubator/jspwiki/tags/release-X.Y.Z-incubating/ -m "jspwiki X.Y.Z-incubating release."
    

Run a vote

Send the following to jspwiki-dev@incubator.apache.org and general@incubator.apache.org:

Subject: [VOTE] Release JSPWiki version X.Y.Z-incubating

This is an incubator release for Apache JSPWiki, version X.Y.Z-incubating.

It fixes the following issues:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310732&version=<REPLACE>

*** Please download, test and vote by [3 working days after sending].

Note that we are voting upon the source (tag), binaries are provided for convenience.

Source and binary files:
http://people.apache.org/~<REPLACE>/jspwiki-X.Y.Z-incubating-candidate-$RC

The tag to be voted upon:
http://svn.apache.org/repos/asf/incubator/jspwiki/tags/release-X.Y.Z-incubating/

JSPWiki's KEYS file containing PGP keys we use to sign the release:
http://www.apache.org/dist/incubator/jspwiki/KEYS

Note that the Incubator PMC needs to vote upon the release after a successful PPMC vote before any release can be made official.

Roll Out

If the vote passes, roll out the release:

  1. Publish src and bin distributions to the mirrors:

    ssh people.apache.org
    VERSION=X.Y.Z
    PREVIOUS_VERSION=X.Y.Z
    CANDIDATE=C
    cp -r ~/public_html/jspwiki-$VERSION-incubating-candidate-$CANDIDATE \
    /www/www.apache.org/dist/incubator/jspwiki/jspwiki-$VERSION-incubating
    cd /www/www.apache.org/dist/incubator/jspwiki
    chgrp -R incubator jspwiki-$VERSION-incubating
    chmod -R g+w jspwiki-$VERSION-incubating
    rm -r /www/www.apache.org/dist/incubator/jspwiki/jspwiki-$PREVIOUS_VERSION-incubating # remove older versions
    

    The last line is to remove the previous version, since only the most recent version on a particular branch should be in the dist directory. Older versions are archived automatically.

  2. Wait 24 hours for mirrors to sync

  3. Post the javadoc to the site:

    1. Create the javadoc:

      ant javadoc
      
    2. Copy javadocs to https://svn.apache.org/repos/infra/websites/production/jspwiki/documentation/javadocs/X.Y.Z-incubating

    3. Add a link to index.html of the javadoc in the documentation/javadoc.mdtext page
  4. Post link to the full release notes along with links to the major JIRA changes on the front page of the site

Announce the release

Send the following from an apache.org address to announce@apache.org, jspwiki-user@incubator.apache.org, jspwiki-dev@incubator.apache.org:

Subject: [ANNOUNCE] Apache JSPWiki X.Y.Z-incubating released

The Apache JSPWiki team is pleased to announce the release of JSPWiki
X.Y.Z-incubating from the Apache Incubator.

This is the <REPLACE> release of Apache JSPWiki, a feature-rich and 
extensible WikiWiki engine built around the standard J2EE components.

The release is available here:
http://www.apache.org/dyn/closer.cgi/incubator/jspwiki/

The full change log is available here:
https://issues.apache.org/jira/browse/jspwiki/fixforversion/<REPLACE>

We welcome your help and feedback. For more information on how to
report problems, and to get involved, visit the project website at
http://incubator.apache.org/jspwiki/

The Apache JSPWiki Team

Add the next release to JIRA

  1. Add the next version number to JIRA
  2. Mark the released version as "released" with a release date
«