z2-Environment

h1. How to Build z2 Base

Starting with z2 v2.6 the z2-Environment comes as a completely self-contained package containing the z2-base components (in particular including Jetty) so that you do not need to setup online copies of z2-base.base unless you plan on patching those components regularly.

In order to build the distribution all you need is

* The required min. Java version (see [[Java Version Requirements]])

* A somewhat up-to-date ANT installation (see https://ant.apache.org/)

In order to build and try out for development create a workspace somewhere and

h3. 1. Clone z2-core

<pre><code class="bash">

git clone https://www.z2-environment.net/git/z2-core

</code></pre>

Note:

* If you do not want to build @master@ switch branches accordingly.

* The build will clone the @z2-base.base@ to include it in the distribution. Before packaging, the build will attempt to checkout the same branch (by name) that is checked out in @z2-core@

h3. 2. Build

Run

<pre><code class="bash">

cd z2-core/package

ant

</code></pre>

After that: 

* A fresh distribution is at @gen/dist@

h3. 3. Run

You can start the just build distribution by running

<pre><code class="bash">

./gui.sh

</code></pre>

However, if you need to frequently rebuild and want to test or develop with other modules located "next" to your z2-core checkout, 

you may want to start using the @gui.sh@ or @go.sh@ scripts located in @z2-core/package@ rather than the ones of the built output.

These scripts overwrite the default location of the development workspace to be "next to z2-core".

h3. 4. Alternative Builds for Distribution

If you want to build an archive, run either

<pre><code class="bash">

ant build_release_candidate

</code></pre>

to create an archive whose name contains the branch name and a timestamp or

<pre><code class="bash">

ant build_release

</code></pre>

to create an archive whose name contains the branch name.