Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Apache Directory Studio (TM)
The Eclipse-based LDAP browser and directory client.
Apache Directory Studio is a complete directory tooling platform intended to be used with any LDAP server however it is particularly designed for use with ApacheDS. It is an Eclipse RCP application, composed of several Eclipse (OSGi) plugins, that can be easily upgraded with additional ones. These plugins can even run within Eclipse itself.
Build from command line
- JDK 8 or newer
- Maven 3 or newer
- Sufficient heap space for Maven:
- FIXME: Windows users have to replace the repository location
eclipse-trgt-platform/template/org.apache.directory.studio.eclipse-trgt-platform.templatewith the actual path, e.g.
You can use either of those two methods to build the project :
Do it manually
Build the 'Eclipse Target Platform' and generate MANIFEST.MF files first
mvn -f pom-first.xml clean install
Build the main eclipse artifacts using Tycho
mvn clean install
Use the script (which runs the two previous commands)
On Linux / Mac OS X :
or on Windows :
- Unit tests included in src/test/java of each plugin are executed automatically and run in 'test' phase
- Core integration tests in tests/test.integration.core are executed automatically and run in 'integration-test' phase
SWTBot based UI integration tests in tests/test.integration.ui are disabled by default. They can be enabled with
-Denable-ui-tests. A failing test generates a screenshot. To not block the developer computer they can run within a virtual framebuffer:
export DISPLAY=:99 Xvfb :99 -screen 0 1024x768x16 &
Tycho doesn't handle snapshot dependencies well. The first time a snapshot dependency is used within the build it is cached in
~/.m2/repository/p2. Afterwards any change in the dependency (e.g. ApacheDS or LDAP API) is not considered unless it is deleted from the cache.
To delete all Apache Directory related snapshots run:
rm -rf ~/.m2/repository/p2/osgi/bundle/org.apache.directory.*
Setup Eclipse workspace
Recommended IDE is 'Eclipse (Luna) for RCP Developers': http://www.eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/lunasr2
Import 'Eclipse Target Platorm' project first
- File -> Import... -> Maven -> Existing Maven Projects
- Choose 'studio/eclipse-trgt-platform' as root directory
- Only this single project is selected
Initialize target platform
- Open the
eclipse-trgt-platform.targetfile with the 'Target Editor'
- In the top right corner click 'Set as Target Platform'
- Open the
Import the main plugins
- File -> Import... -> Maven -> Existing Maven Projects
- Chosse 'studio' as root directory
- All the plugins are selected
During import some Maven plugin connectors need to be installed, accept the installation and restart.
From command line
The build produces binaries for all platforms. Archived versions can be found in
product/target/products/, unpacked versions can be found below
- Open the product configuration 'org.apache.directory.studio.product' with the Product Configuration Editor
- Click the link 'Launch an Eclipse application'
tentative, not fully tested yet...
The root directory contains LICENSE and NOTICE files for the source distribution. The product directory contains LICENSE and NOTICE files for the binary distributions, including licenses for bundled dependencies.
We release the following artifacts:
- Source zip (the main artifact we vote on)
- Maven artifacts
- plugins: pom, jar, javadoc, src
- features: pom, jar, src
- helps: pom, jar, src
- P2 repositories
- the main features (LDAP Browser, Schema Editor, ApacheDS)
- Product archives and installers for
- Linux GTK 32bit tar.gz
- Linux GTK 64bit tar.gz
- Mac OS X 64bit dmg
- Windows 32bit exe installer and zip
- Windows 64bit exe installer and zip
Test the release build: rat check, javadoc and source jar generation, GPG signing, userguide generation
mvn -f pom-first.xml clean install mvn -Papache-release,windows,macos -Duserguides clean install
Run UI tests (if possible on all platforms)
mvn clean install -Denable-ui-tests
Release build steps
As Tycho doesn't support the maven-release-plugin the release process is as follows:
Define release version
We use a release number scheme that suites for both, Maven and Eclipse.
Example for milestone version:
2.0.0.v20150529-M9. Example for GA version:
Define a variable for later use:
Also create an empty directory used during the release process and store it in a variable:
Create and checkout branch
cd $RELEASE_DIR svn copy https://svn.apache.org/repos/asf/directory/studio/trunk https://svn.apache.org/repos/asf/directory/studio/branches/$VERSION -m "Prepare release $VERSION" svn checkout https://svn.apache.org/repos/asf/directory/studio/branches/$VERSION branch-$VERSION cd branch-$VERSION
Remove OpenLDAP feature
As long as the
org.apache.directory.studio.openldap.feature is not ready for release it needs to be removed from
Set the version and commit
find . -name pom-first.xml | xargs sed -i 's/2.0.0-SNAPSHOT/'$VERSION'/' find . -name pom-first.xml | xargs sed -i 's/2.0.0.qualifier/'$VERSION'/' sed -i 's/2.0.0-SNAPSHOT/'$VERSION'/' pom.xml mvn -f pom-first.xml clean install svn revert pom.xml mvn org.eclipse.tycho:tycho-versions-plugin:0.24.0:set-version -DnewVersion=$VERSION svn commit -m "Set version number for release $VERSION"
Create and checkout tag
cd $RELEASE_DIR svn copy https://svn.apache.org/repos/asf/directory/studio/branches/$VERSION https://svn.apache.org/repos/asf/directory/studio/tags/$VERSION -m "Tag release $VERSION" svn checkout https://svn.apache.org/repos/asf/directory/studio/tags/$VERSION tag-$VERSION cd tag-$VERSION
Build the release and deploy to staging Nexus repository
mvn -f pom-first.xml clean install mvn -Papache-release,windows,macos -Duserguides -DretryFailedDeploymentCount=3 clean deploy
Close the staging Nexus repository
Package and sign distribution packages
There is a script that collects and signs all update sites and distribution packages.
For non-interactive signing with GPG agent define env variable:
Run the dist script:
cd dist ./dist.sh
Afterwards all distribution packages are located in
Upload the artifacts to SVN
cd target/$VERSION svn mkdir https://dist.apache.org/repos/dist/dev/directory/studio/$VERSION -m "Create dev area for release $VERSION" svn co https://dist.apache.org/repos/dist/dev/directory/studio/$VERSION . svn add * svn commit -m "Add release $VERSION"
Call the vote
Start the vote.
After successful vote publish the artifacts.
Release artifacts in Nexus.
Move distribution packages from
dev area to
svn mv https://dist.apache.org/repos/dist/dev/directory/studio/$VERSION https://dist.apache.org/repos/dist/release/directory/studio/$VERSION -m "Release $VERSION"
Wait 24h for mirror rsync.
The update site https://svn.apache.org/repos/asf/directory/site/trunk/content/studio/update needs to be updated.
In the following files
change the location path to the new release and also update the
p2.timestamp to the current timestamp milliseconds (hint:
Update news and download links
content/index.mdtext: version string
Delete old releases from
https://dist.apache.org/repos/dist/release/directory/studio/, ensure they were already archived to
Misc tips and tricks
How to search features, plugins, versions in P2 repo?
Start OSGi console:
ss p2.console felix:start -t 999
List all IUs within a repository:
provliu http://download.eclipse.org/eclipse/updates/4.5/ *