To get the source, build the trunks and get along with Maven, follow the instruction given in this page: AUG : 0.2. Building trunks
The version number of ApacheDS has the following form:
This scheme has three number components:
and an optional label that indicates the maturity of a release:
The applicable coding standards for ADS 2.0 are described in Coding Standards
There are some more rules, as we are using Java 6 now :
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, due to some checkstye plugin requiring it. Note that the generated code is Java 7 compliant).
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.
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>
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.
Some things have not yet been automated with maven and require users to manually edit some files. Below are the steps to follow.
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.
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.
Since we are using Nexus for releases the release process is as follows (see also Publishing maven artifacts.
$ 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.
$ mvn deploy -Darguments="-DskipTests"
This is useful to verify your settings in ~/.m2/settings.xml (Nexus password and GPG key)
$ mvn release:clean $ mvn release:prepare
This creates a tag here
$ 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...)
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.
Use your PGP key ID (the pub key, 4096R/[XXXXXXX] where [XXXXXXX] is the key ID)
Note we should not sign with MD5 or SHA-1.
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-256 if [ ! -f "$FILE.sha256" ]; then gpg -v --default-key "$DEFAULT_KEY" --print-md SHA256 "$FILE" > "$FILE".sha256 echo " - Generated '$FILE.sha256'" else echo " - Skipped '$FILE.sha256' (file already existing)" fi # 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' $
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"
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.
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.
Typically, recent versions of Mac OSX moved the tools from /usr/bin to /usr/local/bin
Keep in mind that you will have to sign and move each target package before building the next one, as the clean instruction will remove the content of the target directory...
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.
Start a 72h vote at the dev mailing list.
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 http://www.us.apache.org/dist/directory/apacheds/dist/
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
Staging or Production?
Those files will be stored on the production server only !!! And some extra caution must be taken not to delete them when we will publish the staging site too...
First of all, you must checkout the two CMS store for the site : staging and revision.
$ cd ~/apacheds $ svn co https://svn.apache.org/repos/infra/websites/staging/directory/trunk staging ... $ svn co https://svn.apache.org/repos/infra/websites/production/directory production ...
Now, you will first add the directory for the newly generated version :
$ cd ~/apacheds/production/content/apacheds/gen-docs $ mkdir <version>
Then copy the generated docs :
$ cp -r ~/apacheds/trunks/apacheds/target/checkout/target/site/apidocs ~/apacheds/production/content/apacheds/gen-docs/<version> $ cp -r ~/apacheds/trunks/apacheds/target/checkout/target/site/xref ~/apacheds/production/content/apacheds/gen-docs/<version>
You have to check in those directories :
$ svn add <version> $ svn ci <version> -m "Injected <version> javadocs"
Now, you have to update the staging site, but first, do a svn up. Then you have to update the extpaths.txt file.
This file list the files on the production site that will not be overriden by the publication of the staging site. It has to be updated.
$ cd ~/apacheds/staging/content/ $ vi extpaths.txt
Add the following line :
... # Apacheds apacheds/gen-docs/<version> ...
then save and check in the file.
We also have to update the .htaccess file :
$ cd ~/apacheds/staging/content/apacheds/gen-docs $ vi .htaccess
And update the two last lines to refer to the version you've just released :
RewriteRule ^latest$ <version>/ RewriteRule ^latest/(.*)$ <version>/$1
Save and commit the file.
You can now update the site, add a news on the front page, and publish the site.
There are a few places to modify :
Commit the changes, and publish the web site, you are done !
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 !