Mirroring For The First Time

This document is intended to be read together with the main release instructions. It describes the additional steps that need to be taken when cutting a release for a component that will be mirrored for the first time. As usual, the example text consistently assumes that version 1.2 of component foo is being released.

0 Understanding How Mirroring Works

Read the Apache mirroring guidelines and thenStefan Bodewig's Step-By-Step Guide. Also read and digest this document before starting.

1 Create Directory Structure

The mirrored releases are stored on Daedalus (www.apache.org). The base directory is: 

        /www/www.apache.org/dist/commons/foo

You need to create this directory and the following subdirectories: 

      |--- source/
      |--- binaries/
         |--- platform/  [optional if produce platform-specific binaries]

Please double check that the permissions and ownership are correct. (Everyone should be able to change and read, the group (commons) should be able to write as well.)

The new directory should be automatically mirrored within forty-eight hours.

2 Add Releases To Mirrored Directories

Follow the standard release process (sections 0-10) to create the distributions and upload into the newly created directories.

3 Add Component Entries To Commons Downloads

Add entries for component foo to the Commons download pages.

Edit commons-build/downloads/downloads.xml. Add a new entry for the component, if one does not exist. Please make make sure that your component fits in with the alphabetic ordering.

Test the changes but don't forget that the mirror links won't work until the pages are uploaded. Commit and update the Commons web site in the usual way (see standard release procedure section 11).

4 Update commons release directory

Log on to people.apache.org 

> cd /www/www.apache.org/dist/commons/foo

If a README.html already exists, then edit it. Otherwise, create a new one. This document should tell users that they should download newer releases from the mirrors.

5 Wait Until The Mirrors Are Updated

Please wait until you component's directory appears on the mirrors before continuing with the release and posting your announcements. It's also good practice to test the download once it's been mirrored.

Announcements should be made to the following lists:

  • Commons developer
  • Commons user
  • Apache Announce - must be sent from an apache.org mail address
The subject line should contain: [ANNOUNCE] Commons {component} {m.n} Released
The text of the announcement should contain:
  • Release version and brief description of what the component does.
  • Any particularly significant new features or bug fixes
  • Where to download the release; mention signatures and/or hashes.
  • Component home page
  • How to provide Feedback
Here is an example announce body: 
The Apache Commons team is pleased to announce the release of
version 1.5.4 of Commons Pool.  Commons Pool provides a general
purpose object pooling API, an implementation toolkit and some pool
implementations.

Version 1.5.4 is a patch release including a fix for a regression
introduced in version 1.5. Source and binary distributions are
available for download from the Apache Commons Pool download site:
http://commons.apache.org/pool/download_pool.cgi

Please verify signatures using the KEYS file available at the above
location when downloading the release.

For more information on Apache Commons Pool, visit the Pool home page:
http://commons.apache.org/pool/

Feedback, suggestions for improvement or bug reports are welcome via
the "Mailing Lists" and "Issue Tracking" links here:
http://commons.apache.org/pool/project-info.html

{Release Manager}
- On behalf of the Apache Commons community

Feedback

Feedback - yes please!

Comments, critiques and error reports - post them any and all to the dev mailing list at commons.apache.org. Please prefix with [doc].