Wiki source code of Build Management
Version 10.1 by cds on 2013/01/16 19:01
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Our goal is to keep Code in the KIELER Mainline as stable as possible. Automatic plugin builds and tests after each commit and nightly RCA builds help to improve source code stability. As headless builds of Eclipse plugins and features are not trivial, the following software is used in KIELER | ||
| 2 | |||
| 3 | = Headless Builds (Maven/Tycho) = | ||
| 4 | |||
| 5 | Maven is a build tool for Java projects that handles automatic dependency management including in-build dependencies (the order in which packages are compiled) as well as dependencies to third party libraries, which are automatically fetched from special Maven repositories. A Maven build consists of several phases such as compile, package, etc. Within those phases several Maven plugins handle different tasks (or in maven-speak goals), for example the //maven-compile-plugin// compiles .java files into .class files. Maven builds are configured in XML files calles {{code language="none"}}pom.xml{{/code}}. Those POM files may inherit configuration from a parent POM file, each package contains one {{code language="none"}}pom.xml{{/code}} which containes package specific configuration and a reference to a parent {{code language="none"}}pom.xml. {{/code}}The parent POM includes, besides common configuration, all module names of child POMs. | ||
| 6 | |||
| 7 | Tycho is a set of Maven plugins that handles compiling and dependency management as well as bundling of Eclipse plugins. This means Tycho can read and understand Eclipse metadata files such as plugin.xml or feature.xml, provides dependency information extracted from those files and an Eclipse runtime for compiling and packaging of Eclipse bundles. | ||
| 8 | |||
| 9 | == Maven and Tycho in KIELER == | ||
| 10 | |||
| 11 | In KIELER there is a parent POM located in {{code language="none"}}build/de.cau.cs.kieler.parent{{/code}}, there are mid-level POMs in {{code language="none"}}features{{/code}} and {{code language="none"}}plugins{{/code}} and finally each plugin and feature directory contains a POM file. Furthermore to handle building an Eclipse P2 repository and the KIELER RCA there is a special repository project with its own POM in {{code language="none"}}build/de.cau.cs.kieler.repository{{/code}}. As KIELER is built against a P2 repository generated from our Eclipse reference installation, the following magic command updates the P2 build repository after changes to the installation. | ||
| 12 | |||
| 13 | {{code}} | ||
| 14 | java@aeon:~$ java -jar eclipse_3.8/plugins/org.eclipse.equinox.launcher_*.jar \ | ||
| 15 | -application org.eclipse.equinox.p2.publisher.FeaturesAndBundlesPublisher \ | ||
| 16 | -metadataRepository file:/home/java/repository/juno382 \ | ||
| 17 | -artifactRepository file:/home/java/repository/juno382 \ | ||
| 18 | -source /home/java/eclipse_3.8/ \ | ||
| 19 | -publishArtifacts | ||
| 20 | |||
| 21 | |||
| 22 | {{/code}} | ||
| 23 | |||
| 24 | === Things to be aware of === | ||
| 25 | |||
| 26 | {{warning}} | ||
| 27 | * Eclipse metadata and pom.xml files are not automatically synced. If you change for example version numbers, you have to modify pom.xml | ||
| 28 | * There are files in the parent project which can be also found in the branding plugin. Keep them in sync! | ||
| 29 | {{/warning}} | ||
| 30 | |||
| 31 | |||
| 32 | |||
| 33 | === Building Kieler on the command line === | ||
| 34 | |||
| 35 | A full KIELER build on the command line is done as follows | ||
| 36 | |||
| 37 | {{code title="Full Build" linenumbers="true" language="bash"}} | ||
| 38 | . /home/java/java-env #sets environment variables for java and maven | ||
| 39 | cd build/de.cau.cs.kieler.parent | ||
| 40 | mvn clean package -P <profile> # Available profiles include indigo, juno38, juno42 | ||
| 41 | {{/code}} | ||
| 42 | |||
| 43 | Afterwards the assembled RCA and P2 repository may be found in {{code language="none"}}build/de.cau.cs.kieler.repository/target{{/code}}. Similarly single plugins or features are found in the {{code language="none"}}target {{/code}}subdirectory of the respective package. | ||
| 44 | |||
| 45 | = Automatic Builds (Bamboo) = | ||
| 46 | |||
| 47 | Maven with Tycho only provides the possibility of headless KIELER builds without starting Eclipse. To facilitate automatic builds, further software to monitor source code repositories, start builds after each check-in, notify developers of failed builds, etc. is needed. For KIELER we are using Bamboo by Atlassian | ||
| 48 | |||
| 49 | == Bamboo in KIELER == | ||
| 50 | |||
| 51 | At the moment there are four jobs configured for KIELER | ||
| 52 | |||
| 53 | === Juno 4.2 Continuous Plugins === | ||
| 54 | |||
| 55 | * Builds and tests KIELER plugins after each commit | ||
| 56 | * Sends notifications of failed builds to the responsible developer(s) | ||
| 57 | |||
| 58 | === Juno 4.2 Product Nightly === | ||
| 59 | |||
| 60 | * Builds all of KIELER including all plugins, features as well as the RCA and the KIELER P2 Repository every night. | ||
| 61 | * Deploys RCA and repository to the download server | ||
| 62 | * Assembles the KLay libraries (with and without EMF included) into jar files and deploys them to the download server | ||
| 63 | * Sends notifications about failed commits to the responsible developer(s) and staff members | ||
| 64 | |||
| 65 | === Kieler Rating Nightly === | ||
| 66 | |||
| 67 | * Builds and deploys the KIELER class rating website with a special javadoc doclet | ||
| 68 | |||
| 69 | === Nightly QA Build === | ||
| 70 | |||
| 71 | * Runs nightly static code checkers, code metrics as PMD, FindBugs, Checkstyle etc. | ||
| 72 | |||
| 73 |