Wiki source code of Build Management
Version 13.1 by cds on 2013/04/03 10:26
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{warning}} | ||
| 2 | This page is currently being updated as we work on a revised build process, which is to be explained here in detail. | ||
| 3 | {{/warning}} | ||
| 4 | |||
| 5 | In order to keep the KIELER code as stable as possible, we use automatic continuous integration builds. Once you push something into one of the KIELER repositories, you trigger the automatic build process. If the build fails for whatever reason – be it failed unit tests or simply compilation errors – you are notified of the problem. | ||
| 6 | |||
| 7 | This page describes the software and setup we use to implement all of this. | ||
| 8 | |||
| 9 | **Content** | ||
| 10 | |||
| 11 | |||
| 12 | |||
| 13 | {{toc/}} | ||
| 14 | |||
| 15 | = Software We Use = | ||
| 16 | |||
| 17 | To implement our automatic builds, we use the popular [[Maven>>url:http://maven.apache.org/||shape="rect"]] tool in conjunction with [[Tycho>>url:http://eclipse.org/tycho/||shape="rect"]], a set of Maven plug-ins that allow Maven to build Eclipse projects. To implement our continuous integration builds, we use [[Atlassian Bamboo>>url:http://www.atlassian.com/software/bamboo/overview||shape="rect"]]. | ||
| 18 | |||
| 19 | == Maven / Tycho == | ||
| 20 | |||
| 21 | Maven is a build tool for Java projects. It takes care of dependency management, including in-build dependencies (the order in which packages are compiled) as well as dependencies to third-party libraries. The latter are automatically fetched from special Maven repositories. Without getting too technical, a Maven build consists of several phases, such as //compile// and //package//. Within each phase, several Maven plug-ins handle different //tasks// (or //goals//, as Maven calls them). The //maven-compile-plugin// for example compiles {{code language="none"}}.java{{/code}} files into {{code language="none"}}.class{{/code}} files. | ||
| 22 | |||
| 23 | To correctly compile a project, Maven needs to be told about the project. While the popular Ant build tool uses {{code language="none"}}build.xml{{/code}} files to describe the steps to be executed for building a project, Maven uses {{code language="none"}}pom.xml{{/code}} files to describe the project and figures out the steps for itself. The POM files may inherit settings from a parent POM file. | ||
| 24 | |||
| 25 | Tycho is a set of Maven plugins that handles compiling and dependency management as well as bundling of Eclipse plug-ins. Tycho understands Eclipse metadata files such as {{code language="none"}}plugin.xml{{/code}} or {{code language="none"}}feature.xml{{/code}}, provides dependency information extracted from those files, and provides an Eclipse instance for compiling and packaging Eclipse bundles. | ||
| 26 | |||
| 27 | == Bamboo == | ||
| 28 | |||
| 29 | While Maven and Tycho know how to compile KIELER, Bamboo knows when to compile KIELER and what to do with the compiled project. Bamboo has access to our source code repositories and triggers continuous integration builds every time someone pushes new code into a repository. It also does a full build every night and copies the results onto our nightly build update site to be accessed by people all around the world. And beyond. Tell your friends! | ||
| 30 | |||
| 31 | = The Automatic Build Process = | ||
| 32 | |||
| 33 | === Maven and Tycho in KIELER === | ||
| 34 | |||
| 35 | 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. | ||
| 36 | |||
| 37 | {{code}} | ||
| 38 | java@aeon:~$ java -jar eclipse_3.8/plugins/org.eclipse.equinox.launcher_*.jar \ | ||
| 39 | -application org.eclipse.equinox.p2.publisher.FeaturesAndBundlesPublisher \ | ||
| 40 | -metadataRepository file:/home/java/repository/juno382 \ | ||
| 41 | -artifactRepository file:/home/java/repository/juno382 \ | ||
| 42 | -source /home/java/eclipse_3.8/ \ | ||
| 43 | -publishArtifacts | ||
| 44 | |||
| 45 | |||
| 46 | {{/code}} | ||
| 47 | |||
| 48 | === Things to be aware of === | ||
| 49 | |||
| 50 | {{warning}} | ||
| 51 | * Eclipse metadata and pom.xml files are not automatically synced. If you change for example version numbers, you have to modify pom.xml | ||
| 52 | * There are files in the parent project which can be also found in the branding plugin. Keep them in sync! | ||
| 53 | {{/warning}} | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | === Building Kieler on the command line === | ||
| 58 | |||
| 59 | A full KIELER build on the command line is done as follows | ||
| 60 | |||
| 61 | {{code title="Full Build" linenumbers="true" language="bash"}} | ||
| 62 | . /home/java/java-env #sets environment variables for java and maven | ||
| 63 | cd build/de.cau.cs.kieler.parent | ||
| 64 | mvn clean package -P <profile> # Available profiles include indigo, juno38, juno42 | ||
| 65 | {{/code}} | ||
| 66 | |||
| 67 | 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. | ||
| 68 | |||
| 69 | = Continuous and Nightly Builds = | ||
| 70 | |||
| 71 | There are basically three different build plans for each of the KIELER projects: | ||
| 72 | |||
| 73 | 1. **Continuous Plugins** – Compiles the plug-ins and runs the unit tests on them. None of the compiled artifacts are published anywhere. This plan is triggered by pushing stuff into the repositories, giving early feedback regarding whether committed changes break anything. | ||
| 74 | 1. **Nightly Product** – Compiles the plug-ins and assembles distributable product files and update sites. Distributable files are published in the nightly build directory {{code language="none"}}/home/kieler/public_html/files/nightly{{/code}}. Update sites are published in {{code language="none"}}/home/kieler/public_html/updatesite/nightly{{/code}}. This plan is run once every night. | ||
| 75 | 1. **Nightly Rating** – Compiles the plug-ins and runs our code quality rating doclet on them. The result is a website published at {{code language="none"}}/home/kieler/public_html/rating{{/code}}. This plan is run once every night. | ||
| 76 | |||
| 77 |