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.
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.
You can use either of those two methods to build the project :
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
On Linux / macOS :
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
UI integration tests based on SWTBot 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 &
Some UI integration tests expect a running OpenLDAP server and are skipped otherwise:
docker run -it --rm -p 20389:389 -p 20636:636 --name openldap osixia/openldap:1.3.0
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.* <workspace>/.metadata/.plugins/org.eclipse.pde.core/.bundle_pool/*
Recommended IDE is ‘Eclipse for RCP and RAP Developers’: https://www.eclipse.org/downloads/packages/
Import ‘Eclipse Target Platform’ project first
Initialize target platform
eclipse-trgt-platform.targetfile with the ‘Target Editor’
Import the main plugins
During import some Maven plugin connectors need to be installed, accept the installation and restart.
The build produces binaries for all platforms. Archived versions can be found in
product/target/products/, unpacked versions can be found below
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:
Define the PGP key used to sign the artifacts and the Apple signing ID used to sign the DMG:
export RELEASE_KEY=28686142 export APPLE_SIGNING_ID=2GLGAFWEQD
Note: those are Stefan's keys, replace with your own.
Update the copyright year. Full text search/replace “2006-2020”. Also change in
Test the release build: rat check, javadoc and source jar generation, installer generation, GPG signing, userguide generation:
mvn -f pom-first.xml clean install mvn -Papache-release,windows,macos -Duserguides clean install
Note: During creation of the macOS installer (DMG) the ApacheDirectoryStudio.app is signed with the ASF “Developer ID Application” key. See https://issues.apache.org/jira/browse/INFRA-16978 for the process to get one.
Test the build and sign process for distribution packages:
export VERSION=2.0.0-SNAPSHOT cd dist ./dist.sh
Test the distribution packages:
Run UI tests (if possible on all platforms):
mvn clean install -Denable-ui-tests
As Tycho doesn't support the maven-release-plugin the release process is as follows:
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:
git checkout -b $VERSION-prepare git push origin $VERSION-prepare
As long as the
org.apache.directory.studio.openldap.feature is not ready for release it needs to be removed from
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 git checkout pom.xml mvn org.eclipse.tycho:tycho-versions-plugin:1.2.0:set-version -DnewVersion=$VERSION git commit -am "Set version number for release $VERSION" git push origin $VERSION-prepare
git tag $VERSION git push origin $VERSION
Run the actual release within a fresh checkout to ensure no previous build artifacts are used.
mkdir studio-release cd studio-release git clone https://gitbox.apache.org/repos/asf/directory-studio.git . git checkout $VERSION
mvn -f pom-first.xml clean install mvn -Papache-release,windows,macos -Duserguides -DretryFailedDeploymentCount=3 clean deploy
There is a script that collects and signs all update sites and distribution packages.
Run the dist script:
cd dist ./dist.sh
Afterwards all distribution packages and user guides are located in
cd target/dist/$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" cd ../../..
cd target/ug/$VERSION svn mkdir https://svn.apache.org/repos/infra/websites/production/directory/content/studio/users-guide/$VERSION -m "Create user guides area for release $VERSION" svn co https://svn.apache.org/repos/infra/websites/production/directory/content/studio/users-guide/$VERSION . svn add * svn commit -m "Add release $VERSION" cd ../../..
Note 1: This publishes the user guides directly to the production CMS!
Note 2: In
content/extpaths.txt the parent folder is already whitelisted.
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
Update entry in Eclipse Marketplace: https://marketplace.eclipse.org/content/apache-directory-studio
Also test to install the plugins from marketplace.
Update entry in Mac Ports: https://ports.macports.org/port/directory-studio
Add release to https://reporter.apache.org/?directory
Send the release announce email.
Delete old releases from
https://dist.apache.org/repos/dist/release/directory/studio/, ensure they were already archived to
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: