Summary

• Page properties (1 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

...	...	@@ -36,24 +36,18 @@
36	36
37	37	=== POM Files ===
38	38
39		-The basic structure of the POM files can be seen below:
	39	+The basic structure of the POM files is the same for both, the pragmatics and semantics repository, and can be seen below:
40	40
41	41	[[image:attach:pomfiles.png]]
42	42
43		-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, as well as about every kind of build configuration we have (for building the pragmatics repository, for building the KWebS product, etc.). In addition, the {{code language="none"}}build{{/code}} directory also contains a bunch of subdirectories. These also contain POM files that actually implement the different build configurations to produce p2 repositories and products we can deliver.
	43	+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, as well as about every kind of build configuration we have (for building the pragmatics repository, for building the KWebS product, etc.). In addition, the {{code language="none"}}build{{/code}} directory also contains a bunch of subdirectories housing POM files that produce our p2 repositories and our products.
44	44
45	45	=== Using the KIELER Maven Build ===
46	46
47		-Using the KIELER Maven build requires knowledge about two aspects: necessary configuration / required libraries and invoking Maven.
	47	+Using the KIELER Maven build requires two things: a working Maven installation (d'oh...) and knowledge about how exactly to trigger a build. We leave the former to you, but the latter is what this section is about.
48	48
49		-==== Necessary Configuration ====
	49	+To actually build KIELER, navigate to the {{code language="none"}}/build/{{/code}} directory and run the following command line:
50	50
51		-KIELER needs to be built against a P2 repository generated from an Eclipse reference installation (the //target platform//). The command for doing that is described on [[this page>>doc:Eclipse Server Installation]]. The target platform is available online so you don't have to worry about it when building KIELER on your local computer.
52		-
53		-==== Invoking Maven ====
54		-
55		-To actually build KIELER once all preliminaries are done, navigate to the {{code language="none"}}/build/{{/code}} directory and run the following command line:
56		-
57	57	{{code language="none"}}
58	58	. /home/java/java-env # Only necessary when working on our servers
59	59	mvn clean package -P <profile>
...	...	@@ -61,12 +61,15 @@
61	61
62	62	Once Maven has finished, the different build artifacts may be found in the {{code language="none"}}/build/de.cau.cs.kieler.<profile>.repository/target{{/code}} directories. The following build profiles are available in the KIELER Pragmatics repository:
63	63
64		-* klighdning – Builds a standalone version of the KLighDning server.
65		-* kwebs – Builds a standalone version of the KWebS server.
66		-* papyrus – Builds a p2 repository that contains our feature for adding automatic layout to a Papyrus installation.
67		-* pragmatics – Builds a p2 repository that contains our pragmatics features.
68		-* ptolemy-rcp – Produces a standalone version of our Ptolemy Model Viewer.
	58	+* klighdning – Builds a standalone version of the KLighDning server, based on the current nightly pragmatics update site.
	59	+* kwebs – Builds a standalone version of the KWebS server, based on the current nightly pragmatics update site.
	60	+* pragmatics – Builds a p2 repository that contains our pragmatics features. This is what would usually be pushed online for people to download as our nightly pragmatics build.
	61	+* ptolemy-rcp – Produces a standalone version of our Ptolemy Model Viewer, based on the current nightly build pragmatics update site.
69	69
	63	+The following build profiles are available in the KIELER Semantics repository:
	64	+
	65	+* TODO: Add build profiles.
	66	+
70	70	=== What to Be Aware of ===
71	71
72	72	There are some things that people need to be aware of to keep the build files in a valid state.
...	...	@@ -78,15 +78,21 @@
78	78
79	79	We distribute our KLay layout algorithms in two library files: one that contains just our algorithms, and another one that also contains dependencies such as required EMF classes. To build the KLay libraries, navigate to the {{code language="none"}}/build/de.cau.cs.kieler.klay.libraries{{/code}} directory and do the following:
80	80
81		-1. Set the TARGET_PLATFORM environment variable to point to a local copy of our currently used target platform p2 repository.
82		-1. Set the {{code language="none"}}KIELER_REPOSITORY{{/code}} environment variable to point to a local copy of a p2 repository of our pragmatics build.
	78	+1. Set the TARGET_PLATFORM environment variable to point to a local copy of our currently used target platform p2 repository. Ask {{mention reference="XWiki.cds" style="FULL_NAME" anchor="XWiki-cds-BDGaI"/}} where you can get that.
	79	+1. Set the {{code language="none"}}KIELER_REPOSITORY{{/code}} environment variable to point to a local copy of a p2 repository of our pragmatics build. Again, ask {{mention reference="XWiki.cds" style="FULL_NAME" anchor="XWiki-cds-eBnpF"/}} where you can get that.
83	83	1. Run Ant on the {{code language="none"}}build.xml{{/code}} file. This will produce both versions of the KLay layout library.
84	84
	82	+{{note}}
	83	+We would love to switch our KLay library build over to Maven since that would allow us to publish the library in an official Maven artifact repository.
	84	+{{/note}}
	85	+
	86	+
	87	+
85	85	== Continuous and Nightly Builds ==
86	86
87		-There are basically three different build plans for each of the KIELER projects:
	90	+There are basically four different kinds of build plans for each of the KIELER projects:
88	88
89		-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.
	92	+1. **Continuous Plugins** – Compiles the plug-ins and runs the unit tests on them. None of the compiled artifacts are published anywhere (in fact, no update site or product is even produced). This plan is triggered by pushing stuff into the repositories, giving early feedback regarding whether committed changes break anything.
90	90	1. **Nightly <Product>** – Assembles distributable product files and/or 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}}. These plans are run once every night.
91	91	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.
92	92	1. **Release Builds** – Continuous builds of release branches once a release is imminent. These usually run whenever changes are pushed into the repository.

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-7701017
	1	+8650846

URL

...	...	@@ -1,1 +1,1 @@
1		-https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7701017/Build Management
	1	+https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/8650846/Build Management