tree: 9646e8ce952eb14a46f48074d23bf9913e184994 [path history] [tgz]
  1. eclipse-target-platform/
  2. features/
  3. helps/
  4. p2repository/
  5. plugins/
  6. product/
  7. src/
  8. tests/
  9. tools/
  10. .gitignore
  11. build.bat
  12. build.sh
  13. doap_dirstudio.rdf
  14. LICENSE.txt
  15. NOTICE.txt
  16. pom-first.xml
  17. pom-project.xml
  18. pom.xml
  19. README.md
  20. settings.xml.release
  21. settings.xml.sample
README.md

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

http://www.apache.org/licenses/LICENSE-2.0

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.

Build from command line

You can use either of those two methods to build the project :

Do it manually

  1. Build the ‘Eclipse Target Platform’ and generate MANIFEST.MF files first

    mvn -f pom-first.xml clean install

  2. Build the main eclipse artifacts using Tycho

    mvn clean install

Use the script (which does run the two previous commands)

On Linux / Mac OS X :

$ ./build.sh

or on Windows :

> build.bat

Tests

  • 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 diabled by default. They can be enabled with -Denable-ui-tests. A failing test generates a screenshot. To not block the developer computer UI tests they can run within a virtual framebuffer: export DISPLAY=:99 Xvfb :99 -screen 0 1024x768x16 &

Build issues

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 the considered unless it is deleted from the cache.

Setup Eclipse workspace

Recommended IDE is ‘Eclipse (Luna) for RCP Developers’: http://www.eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/lunasr1

  1. Import ‘Eclipse Target Platorm’ project first

    • File -> Import... -> Maven -> Existing Maven Projects
    • Choose ‘studio/eclipse-target-platform’ as root directory
    • Only this single project is selected
    • Finish
  2. Initialize target platform

    • Open the eclipse-target-platform.target file with the ‘Target Editor’
    • In the top right corner click ‘Set as Target Platform’
  3. Import the main plugins

    • File -> Import... -> Maven -> Existing Maven Projects
    • Chosse ‘studio’ as root directory
    • All the plugins are selected
    • Finish

During import some Maven plugin connectors need to be installed, accept the installation and restart.

Run

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 product/target/products/org.apache.directory.studio.product

Within Eclipse

  • Open the product configuration ‘org.apache.directory.studio.product’ with the Product Configuration Editor
  • Click the link ‘Launch an Eclipse application’

Release

Work in progress...

Preparation

Check legal files

mvn apache-rat:check

Run UI tests (if possilbe on all platforms)

mvn clean install -Denable-ui-tests

Generate help plugins

cd helps
mvn clean install -Duserguides

Update site (p2 repo) is generated in product/target/repository

Distribution files are generated in product/target/products

Misc tips and tricks

How to search features, plugins, versions in P2 repo?

https://stackoverflow.com/questions/10025599/how-to-find-out-which-feature-contains-a-needed-plug-in-on-an-eclipse-download-s