Developers Guide

Getting the source, Building the trunks

To get the source, build the trunks and get along with Maven, follow the instruction given in this page: AUG : 0.2. Building trunks

Versioning Scheme

The version number of ApacheDS has the following form:

This scheme has three number components:

• The major number increases when there are incompatible changes in the API.
• The minor number increases when a new feature is introduced.
• The micro number increases when a bug or a trivial change is made.

and an optional label that indicates the maturity of a release:

• M (Milestone) means the feature set can change at any time in the next milestone releases. The last milestone release becomes the first release candidate after a vote.
• RC (Release Candidate) means the feature set is frozen and the next RC releases will focus on fixing problems unless there is a serious flaw in design. The last release candidate becomes the first GA release after a vote.
• No label implies GA (General Availability), which means the release is stable enough and therefore ready for production environment.

Coding standards

The applicable coding standards for ADS 2.0 are described in Coding Standards

There are some more rules, as we are using Java 8 now :

• Use generics as much as you can. Generic are a good way to avoid casting, and it enforce the usage of the correct type.
• If you can avoid Iterators, do so. There is this cool construction with a for( Type t: ) : use it !
• Use assert. It’s usefull, especially instead of a bunch of if () then throw Exception* when controlling incoming parameters
• Use the new Enum type !

Releasing ApacheDS

Here is a guide on how to cut a new release. This is a long process, expect it to last a few hours !

First, you need to have a recent version of Maven (we are using 3.0.4) and a recent version of the JDK (Java 8 is required).

Maven Settings

You’ll need a settings section for the Nexus and people.apache.org servers with a password or a path to the SSH key used. Here’s what my settings.xml file in ~/.m2 looks like:

<settings>

  <servers>
    <!-- To publish a snapshot of some part of Maven -->
    <server>
      <id>apache.snapshots.https</id>
      <username>username</username>
      <password>********</password>
    </server>

    <!-- To publish a website using Maven -->
    <server>
      <id>apache.directory</id>
      <username>username</username>
      <privateKey>/Users/username/.ssh/id_rsa</privateKey>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
    </server>

    <!-- To stage a release of some part of Maven -->
    <server>
      <id>apache.releases.https</id>
      <username>username</username>
      <password>********</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>elecharny</username>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
    </server>

  </servers>    

  <profiles>
    <profile>
      <id>apache-public</id>
      <pluginRepositories>
        <pluginRepository>
          <id>apache.public</id>
          <url>https://repository.apache.org/content/groups/public/</url>
        </pluginRepository>
      </pluginRepositories>
    </profile>

    <profile>
      <id>apache-release</id>
      <!-- Configuration for artifacts signature -->
      <properties>
        <gpg.passphrase>********</gpg.passphrase>
        <gpg.keyname>elecharny@apache.org</gpg.keyname>
      </properties>
    </profile>
  </profiles>

</settings>

Just replace your username, passwords and paths. Note that the username and password is your Apache LDAP account.

GPG Key

All subprojects are configured to deploy signatures for the artifacts uploaded to the repository. The gpg plugin will check use the default gpg key for the user deploying the project with the release:perform directive of the release plugin. This will prompt you for the passphrase for the default key. If you do not have one setup the build will fail.

You can generate and upload a PGP key to a PGP keyserver using the following commands:

gpg --gen-key
gpg --fingerprint
gpg --keyserver subkeys.pgp.net --send-keys <your key's id from last command>

Releasing ApacheDS

Now that your environment has been setup, we will show you how to build and release the ApacheDS subproject. Keep an eye out for warnings and note sections that show version specific differences in this process.

Manual Steps

Some things have not yet been automated with maven and require users to manually edit some files. Below are the steps to follow.

Update the apacheds/pom.xml

The current apacheds/pom.xml contains references to LDAP API SNAPSHOTs, which is not good. You have to bump up those references to the latest LDAP-API version.

Update service/apacheds.sh and service/apacheds.bat

Edit the apacheds.sh/bat files in the service project directory to update the revision numbers used in that file to reference non-SNAPSHOT releases.

Release process

Since we are using Nexus for releases the release process is as follows (see also Publishing maven artifacts.

Test the Project

$ mvn release:prepare -DdryRun=true

Replace the version by the new version. Be careful, and remove the ‘apacheds-parent-’ which is proposed for the new tag. We should just use the version number.

Deploy a Snapshot

$ mvn deploy -Darguments="-DskipTests"

This is useful to verify your settings in ~/.m2/settings.xml (Nexus password and GPG key)

Prepare the Release

$ mvn release:clean
$ mvn release:prepare

This creates a tag here

Stage the Release

$ mvn release:perform -Darguments="-DskipTests"

This deploys the release to a staging repository. Go to Staging Repositories and close the staging repository.

(The -Darguments=”-DskipTests” parameter is there to avoid running the tests again…)

Build the Site

We will now build the site. This will be done from the target/checkout directory :

$ cd target/checkout

In order to generate the site, you have to comment some modules in the apacheds pom.xml file :

<!--module>all</module-->
...
<!--module>installers-maven-plugin</module-->
<!--module>installers</module-->
...
<!--module>service</module-->

Then you can start the maven command :

$ mvn site

This creates the site and the Javadocs.

You can get the keys by typing :

gpg --list-keys

You can use this small script that does the job (copy-paste this code in a file named sign.sh in your path) :

#!/bin/sh

echo "PGP Key ID: "
read DEFAULT_KEY

echo "PGP Key Password: "
stty -echo
read PASSWORD
stty echo
echo ""

for FILE in $(find . -maxdepth 1 -not '(' -name "sign.sh" -or -name ".*" -or -name "*.md5" -or -name "*.sha1" -or -name "*.asc" ')' -and -type f) ; do

    if [ -f "$FILE.asc" ]; then
        echo "Skipping: $FILE"
        continue
    fi

    echo -n "Signing: $FILE ... "

    # SHA-512
    if [ ! -f "$FILE.sha512" ];
    then
        gpg -v --default-key "$DEFAULT_KEY" --print-md SHA512 "$FILE" > "$FILE".sha512
        echo "  - Generated '$FILE.sha512'"
    else
        echo "  - Skipped '$FILE.sha512' (file already existing)"
    fi

    # ASC
    if [ ! -f "$FILE.asc" ];
    then
        echo "$PASSWORD" | gpg --default-key "$DEFAULT_KEY" --detach-sign --armor --no-tty --yes --passphrase-fd 0 "$FILE"
        echo "  - Generated '$FILE.asc'"
    else
        echo "  - Skipped '$FILE.asc' (file already existing)"
    fi
done

Then to sign the packages :

$ sign.sh
PGP Key ID: 
<your PGP key>
PGP Key Password: 
<Your password>

-n Signing: ./apacheds-parent-<version>-source-release.zip ... 
- Generated './apacheds-parent-<version>-source-release.zip.md5'
- Generated './apacheds-parent-<version>-source-release.zip.sha1'
- Generated './apacheds-parent-<version>-source-release.zip.asc'
$

Publish Source Distribution Package

The sources, binaries and their signatures, have to be pushed in a place where they can be downloaded by the other committers, in order to be checked while validating the release. As the ~/people.apache.org server is not anymore available for that purpose, we use the distribution space for that purpose.

If you haven’t checked out this space, do it now :

$ mkdir -p ~/apacheds/dist/dev/directory
$ svn co https://dist.apache.org/repos/dist/dev/directory ~/apacheds/dist/dev/directory

That will checkout the full project distributions.

You may want to checkout only the part that you are going to generate, to avoid getting Gb of data :

$ mkdir -p ~/apacheds/dist/dev/directory/apacheds
$ svn co https://dist.apache.org/repos/dist/dev/directory/apacheds ~/apacheds/dist/dev/directory/apacheds

Now, create a sub-directory for the version you have generated (here, for version 2.0.0-M22) :

$ mkdir ~/apacheds/dist/dev/directory/apacheds/2.0.0-M22

and copy the packages and signature to this area :

$ cd target/checkout/target
$ cp apacheds-parent-<version>-source-release.zip* ~/apacheds/dist/dev/directory/apacheds/2.0.0-M22

Last, not least, commit your changes

$ svn add ~/apacheds/dist/dev/directory/apacheds/2.0.0-M22
$ svn ci ~/apacheds/dist/dev/directory/apacheds/2.0.0-M22 -m "ApacheDS 2.0.M22 packages"

Test the new version

The best way to do that is to download the sources, extract them, build the server and the installers, and check if the installers are correctly working. Then check that the server is correctly running.

Create the installers

We now have to create the installers. Go into the target/checkout directory and run :

$ cd apacheds/target/checkout/installers
$ mvn clean install -Pinstallers

This will create the installers in the target/checkout/installers/target/installers directory

This will build only one single target.

Sign those installers using the sign.sh script, and copy them in ~/apacheds/dist/dev/directory/apacheds/

$ cd apacheds/target/checkout/target/installers/target/installers
$ cp apacheds-<version>* ~/apacheds/dist/dev/directory/apacheds/2.0.0-M22

Note : you will need a Debian, a Fedora and a Windows server to generate dedicated binaries for those platforms, or you can use rpmbuild, dpkg or nsis if you don’t want to use many different servers.

Vote

Start a 72h vote at the dev mailing list.

Release

If the vote succeeds Apacheds project can be released.

Go to https://repository.apache.org/index.html#stagingRepositories and release the staging repository so all artifacts are published to Maven central.

The sources, binaries and their signatures, have to be pushed in a place where they can be downloaded by users. We use the distribution space for that purpose.

Move the distribution packages (sources and binaries) to the dist SVN repository: https://dist.apache.org/repos/dist/release/directory/apacheds/dist/$(version)

If you haven’t checked out this space, do it now :

$ mkdir -p ~/apacheds/dist/release/directory
$ svn co https://dist.apache.org/repos/dist/release/directory ~/apacheds/dist/release/directory

That will checkout the full project distributions.

You may want to checkout only the part that you are going to generate, to avoid getting Gb of data :

$ mkdir -p ~/apacheds/dist/release/directory/apacheds/dist
$ svn co https://dist.apache.org/repos/dist/release/directory/apacheds/dist ~/apacheds/dist/release/directory/apacheds/dist

Then move the packages from ‘dev’ to ‘release’ :

# cd dist/release/directory/apacheds/dist
# cp ~/apacheds/dist/dev/directory/apacheds/<version> .
# svn add <version>
# svn ci <version>
...
# exit
$

The packages should now be available on https://www.apache.org/dist/directory/apacheds/dist/

Deploy the Javadocs and XRef

We now can deploy the generated Javadoc and cross-reference pages. They are generated in the following directory :

target/checkout/target/site

We will copy two directories :

• apidocs
• xref

They are uploaded to https://nightlies.apache.org/ via WebDAV protocol.

First create the folders for the version:

$ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/directory/apacheds/<version>/'
$ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/directory/apacheds/<version>/apidocs'
$ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/directory/apacheds/<version>/xref'

I used Rclone to copy folders via WebDAV.

After intallation run rclone config and configure the nightlies connection:

$ rclone config
name: nightlies
type: webdav
url: https://nightlies.apache.org
vendor: other
user: yourasfid
pass: yourasfpassword (will be stored encrypted)

Then copy the directories:

cd target/checkout/target/site
rclone copy --progress apidocs nightlies:/directory/apacheds/<version>/apidocs
rclone copy --progress xref nightlies:/directory/apacheds/<version>/xref

Finally update the links in the static/apacheds/gen-docs/.htaccess of the directory-site repo:

RewriteRule ^latest$ https://nightlies.apache.org/directory/apacheds/<version>/ [QSA,L]
RewriteRule ^latest/(.*)$ https://nightlies.apache.org/directory/apacheds/<version>/$1 [QSA,L]

Save and commit the file.

Update the web site

You can now update the site, add a news on the front page, and publish the site.

There are a few places to modify :

• /config.toml : update the version_apacheds variable with the new version.
• /source/_index.md : same here, update the section, which contains the version.
• /source/apacheds/news.md : add the news on top of this page
• /source/apacheds/download-old-versions.md : add a new line on top of the array, which refers to the latest version before the new one

PS: You can check the result of your modification on the build system. If you have made an error, the web site won’t be updated, without notice, but there!

Commit the changes, and publish the web site, you are done !

Inform the world !

After 24h, you can now inform the world about the release.

Send a mail to the users and dev mailing list, and one to the announce@apache.org

You are done !