Changes for page Build Management
Last modified by Richard Kreissig on 2023/09/14 08:50
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -30,42 +30,57 @@ 30 30 31 31 = The Automatic Build Process = 32 32 33 - ===Maven andTycho in KIELER===33 +This section describes how our POM files are distributed throughout the repository structure, and how you can trigger an automatic build of KIELER. 34 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 aPOMfile.Furthermore to handle building an EclipseP2 repositoryand 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.35 +== POM Files == 36 36 37 -{{code}} 38 -java@aeon:~$ java -jar eclipse_3.8/plugins/org.eclipse.equinox.launcher_*.jar \ 37 +The basic structure of the POM files can be seen below: 38 + 39 +[[image:attach:pomfiles.png]] 40 + 41 +Each plug-in and feature has a corresponding (usually rather small) POM file. The POM files in the {{code language="none"}}features{{/code}} and {{code language="none"}}plugins{{/code}} directories know about the different features and plug-ins. The parent POM file, which all other POM files copy basic configuration from, knows about the feature and plug-in POM files. In addition, the {{code language="none"}}build{{/code}} directory also contains a bunch of subdirectories. These also contain POM files specialized for building the P2 repositories necessary to publish our Eclipse features. 42 + 43 +== Using the KIELER Maven Build == 44 + 45 +Using the KIELER Maven build requires knowledge about two aspects: necessary configuration / required libraries and invoking Maven. 46 + 47 +=== Necessary Configuration === 48 + 49 +KIELER needs to be built against a P2 repository generated from our Eclipse reference installation. The path to this repository is found in the parent POM file and must be changed if the repository location changes. Also, when changing the reference installation, the repository has to be updated using the following magic command (adapted accordingly): 50 + 51 +{{code language="none"}} 52 +java -jar eclipse_3.8/plugins/org.eclipse.equinox.launcher_*.jar \ 39 39 -application org.eclipse.equinox.p2.publisher.FeaturesAndBundlesPublisher \ 40 40 -metadataRepository file:/home/java/repository/juno382 \ 41 41 -artifactRepository file:/home/java/repository/juno382 \ 42 42 -source /home/java/eclipse_3.8/ \ 43 43 -publishArtifacts 58 +{{/code}} 44 44 60 +=== Invoking Maven === 45 45 62 +To actually build KIELER once all preliminaries are done, navigate to the {{code language="none"}}/build/de.cau.cs.kieler.parent{{/code}} directory and run the following command line: 63 + 64 +{{code language="none"}} 65 +mvn clean package -P <profile> # For a list of available profiles, see parent pom.xml 46 46 {{/code}} 47 47 48 - ===Thingsto be awareof===68 +If you are trying to build KIELER on our server, you first have to setup the Java environment, if you haven't already done so. The command line thus becomes: 49 49 50 -{{ warning}}51 - *Eclipse metadata and pom.xml filesare notautomatically synced. If you change for exampleversion numbers, you have to modify pom.xml52 - *There are files intheparentprojectwhichcanbealsofoundin thebranding plugin.Keepthem insync!53 -{{/ warning}}70 +{{code language="none"}} 71 +. /home/java/java-env 72 +mvn clean package -P <profile> # For a list of available profiles, see parent pom.xml 73 +{{/code}} 54 54 55 - 75 +Once Maven has finished, the different build artifacts may be found in the {{code language="none"}}/build/de.cau.cs.kieler.*.repository/target{{/code}} directories. 56 56 57 -== =BuildingKieleronthecommand line ===77 +== What to Be Aware of == 58 58 59 - AfullKIELERbuild onthecommandlineisdoneasfollows79 +There are some things that people need to be aware of to keep the build files in a valid state. 60 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}} 81 +1. Eclipse metadata and POM files are not synchronized. Thus, if the version of an Eclipse plug-in changes, its {{code language="none"}}pom.xml{{/code}} needs to be updated accordingly. 82 +1. The repository POM directories contain product files and product icons. These are copies of the files found in the corresponding branding plug-ing (such as {{code language="none"}}de.cau.cs.kieler.core.product{{/code}}) and have to be manually synchronized. 66 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 69 = Continuous and Nightly Builds = 70 70 71 71 There are basically three different build plans for each of the KIELER projects:
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 -61604 091 +6160411 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/61604 09/Build Management1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/6160411/Build Management