Return-Path: X-Original-To: apmail-continuum-commits-archive@www.apache.org Delivered-To: apmail-continuum-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 6F88BD96C for ; Fri, 23 Nov 2012 05:13:35 +0000 (UTC) Received: (qmail 90248 invoked by uid 500); 23 Nov 2012 05:13:35 -0000 Delivered-To: apmail-continuum-commits-archive@continuum.apache.org Received: (qmail 90189 invoked by uid 500); 23 Nov 2012 05:13:33 -0000 Mailing-List: contact commits-help@continuum.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@continuum.apache.org Delivered-To: mailing list commits@continuum.apache.org Received: (qmail 90177 invoked by uid 99); 23 Nov 2012 05:13:32 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 23 Nov 2012 05:13:32 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 23 Nov 2012 05:13:28 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id E79D4238897F for ; Fri, 23 Nov 2012 05:13:06 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1412755 - in /continuum/trunk/continuum-docs/src/site: ./ apt/administrator_guides/ resources/images/ Date: Fri, 23 Nov 2012 05:13:06 -0000 To: commits@continuum.apache.org From: brett@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121123051306.E79D4238897F@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: brett Date: Fri Nov 23 05:13:03 2012 New Revision: 1412755 URL: http://svn.apache.org/viewvc?rev=1412755&view=rev Log: [CONTINUUM-2025] improve documentation for build environments Submitted by: Brent Atkinson Added: continuum/trunk/continuum-docs/src/site/resources/images/installation-envvar-edit.png (with props) continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice-envvar.png (with props) Modified: continuum/trunk/continuum-docs/src/site/apt/administrator_guides/buildEnvironment.apt continuum/trunk/continuum-docs/src/site/apt/administrator_guides/builder.apt continuum/trunk/continuum-docs/src/site/apt/administrator_guides/index.apt continuum/trunk/continuum-docs/src/site/resources/images/buildenv-add.png continuum/trunk/continuum-docs/src/site/resources/images/buildenv-in-builddef.png continuum/trunk/continuum-docs/src/site/resources/images/buildenv-setup-jdk.png continuum/trunk/continuum-docs/src/site/resources/images/installation-tool-edit.png continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice.png continuum/trunk/continuum-docs/src/site/resources/images/installation-validation-failed.png continuum/trunk/continuum-docs/src/site/site.xml Modified: continuum/trunk/continuum-docs/src/site/apt/administrator_guides/buildEnvironment.apt URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/administrator_guides/buildEnvironment.apt?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== --- continuum/trunk/continuum-docs/src/site/apt/administrator_guides/buildEnvironment.apt (original) +++ continuum/trunk/continuum-docs/src/site/apt/administrator_guides/buildEnvironment.apt Fri Nov 23 05:13:03 2012 @@ -6,22 +6,39 @@ Oct 17 2007 ------ -Build Environment - ~~%{toc|section=0} -* Goal +Managing Build Environments - The main goal is to compile/test sources against the targeted jvm, mvn/maven version, ant version and to add defined - envvar (MAVEN_OPTS, ANT_OPTS ...). This is now possible at the build definition level (in 1.1). + In continuum, Build Environments allow you to create and manage multiple build + configurations. Once you have defined the Build Environments you can configure + project Build Definitions or {{{./builddefTemplate.html}Build Definition + Templates}} to use them. + + + +*Build Environments + + Build Environments are named groupings of {{{./builder.html}Installations}}. By + grouping the collection of Tools and Environment Variables, you define a + configuration that can be used to build a project. To define a Build + Environment, you specify a human friendly name and add one or more + Installations. Once defined, the Build Environment is available for use. You + can then specify what Build Environment to use in your project's Build + Definitions or in your Build Definition Templates. When continuum detects that + a project needs to be built, it uses the Tool Installations to construct the + paths to the expected executables (ie. Maven build definitions construct paths + to the mvn executable and the java executable). Additional Installations are + translated into name/value pairs that are passed through to the constructed + command's environment. As of Continuum 1.2.1, build environments can be used in releasing projects. This is set upon supplying the release prepare parameters during the {{{../user_guides/release/prepare.html} Release preparation}} of the project. -* Setup Build Environments/Installations - -** {Creating a Build Environment} +**Creating a Build Environment From the menu, choose the 'Build Environments' entry @@ -37,36 +54,44 @@ Build Environment [../images/profile-build-agent-group.png] Add Build Agent Group to Build Environment -** {Attach JDK to a Build Environment} +**Attaching the related Installations - The list box contains all available installations (jdk, mvn etc..). The installation's type is automatically recognized. - In the modification mode of a build environment, adding an already attached type will override the existing one. + When editing a Build Environment, the Installation list box contains all + defined Installations. You can only specify a single Tool Installation per type + (jdk, maven, maven2, ant). However, you may specify multiple Environment + Variable Installations. -[../images/buildenv-setup-jdk.png] Add JDK to Build Environment +[../images/buildenv-setup-jdk.png] Adding Installations to Build Environment -** {Link Build Environment to Build Definition} +**Setting a Build Definition's Build Environment - The list box contains all availables installations (jdk, mvn etc..). The installation's type is automatically recognized. - In the modification mode of a build environment, adding an already attached type will override the existing one. + The way you configure builds to use your newly created Build Environments is by + setting it in either a project Build Definition or in the continuum Build + Definition Templates. The following example sets the Build Environment of a + specific project's Build Definition. [../images/buildenv-in-builddef.png] Setup Build Environment -** {Installations used in Notification mail} +**Installations used in Notification mail - The notification mail contains the following informations : + Build notifications send along information about the environment in which the + project was built. * Java Home version : coming from $JAVA_HOME/bin/java -version. - * Builder version : coming from builder used version arg (mvn used -v, ant use -version). - + * Builder version : coming from builder used version arg (mvn used -v, ant + use -version). + [] +-------------------------------+ - Java Home version : - java version "1.4.2_06" - Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_06-b03) - Java HotSpot(TM) Client VM (build 1.4.2_06-b03, mixed mode) - + Java Home version : + java version "1.6.0_11" + Java(TM) SE Runtime Environment (build 1.6.0_11-b03) + Java HotSpot(TM) Client VM (build 11.0-b16, mixed mode, sharing) + Builder version : - Maven version: 2.0.5 + Maven version: 2.0.9 + Java version: 1.6.0_11 + OS name: "linux" version: "2.6.16.60-0.23-default" arch: "i386" Family: "unix" +-------------------------------+ Modified: continuum/trunk/continuum-docs/src/site/apt/administrator_guides/builder.apt URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/administrator_guides/builder.apt?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== --- continuum/trunk/continuum-docs/src/site/apt/administrator_guides/builder.apt (original) +++ continuum/trunk/continuum-docs/src/site/apt/administrator_guides/builder.apt Fri Nov 23 05:13:03 2012 @@ -1,14 +1,50 @@ ------ - Managing Building Tool + Managing Installations ------ Olivier Lamy ------ Oct 11 2007 ------ -Managing Building Tool +Managing Installations - From the menu, choose the 'Installations' entry + Continuum allows you to configure the build tools it uses to build projects by + defining {{{./buildEnvironment.html}Build Environments}}. Installations allow defining + environment settings and are the basic unit of a Build Environment. + + For example, say you need to maintain two build environments. One using JDK 5 + and Maven 2.0.9 and another using JDK 6 and Maven 2.1.0-M1. To achieve this, + you would need to do the following: + + [[1]] Create Installations for the versions of Java and Maven. + + [[2]] Create Installations for any environment variables you want to set such + as MAVEN_OPTS and ANT_OPTS. + + [[3]] Create the desired Build Environments, specifying the combination of + Installations to use. + + [[4]] Assign the Build Environments to your Build Definition Templates or + project-specific Build Definitions. + + [] + +*Installations + + Installations are essentially named environment variables. There are currently + two types of Installations: Tools and Environment Variables. + +**Tools + + Tools are meant to provide locations to pre-defined tool types. Currently, + continuum allows you to define locations for the JDK, Maven 2, Maven 1 and Ant. + When you create a tool installation, you specify a human-friendly name, the + tool type, and the path to tool. Continuum verifies that the specified tool + type resides in that location or fails to create the Installation. + +***Example: Defining a Maven2 Installation + + From the menu, choose the 'Installations' entry [../images/installations.png] Installations @@ -20,9 +56,7 @@ Managing Building Tool [../images/installation-tool-edit.png] Tool Setup - You can use the checkbox if you want to add a Profile with the same name as your tool name. - - The value 'Value/Path' field must contains the path to the tool : + The value 'Value/Path' field must specify the path to the tool: * For maven2 : it must be similar to your M2_HOME @@ -30,14 +64,46 @@ Managing Building Tool * For ant : it must be similar to your ANT_HOME - A control will be made to validate the path value : + [] + + Continuum validates the path specified depending on the type of Tool: - * For maven2 : path/bin/mvn -v will be tested + * For maven2 : \/bin/mvn -v will be tested - * For maven1 : path/bin/maven -v will be tested + * For maven1 : \/bin/maven -v will be tested - * For ant : path/bin/ant -v will be tested + * For ant : \/bin/ant -v will be tested + + [] - It the the test, the following error will be displayed + If the path you specify fails the test, the following error will be displayed: [../images/installation-validation-failed.png] Installation validation failed + + You can use the checkbox if you want to create a Build Environment with the + same name as your Tool name. + +**Environment Variables + + Environment Variables are simply a means to store environment settings using a + human-friendly name. Once defined, they can be used to affect the build tools + used to build your projects. They consist of a human-friendly name, the name of + the environment variable to set and the value. Unlike Tools, Environment + Variables are not constrained by continuum. No validation is performed to + validate the values. + +***Example: Defining a Java Heap size Environment Variable for Maven2 Tools + + From the menu, choose the 'Installations' entry + +[../images/installations.png] Installations + + Select the Environment Variable Installation type + +[../images/installation-type-choice-envvar.png] Select env var as tool type + + And finally, specify the human-friendly name, the environment variable name and + the corresponding value. Here we define MAVEN_OPTS that will set the Java heap + size to 256 Megabytes. + +[../images/installation-envvar-edit.png] Define the env var name and value Modified: continuum/trunk/continuum-docs/src/site/apt/administrator_guides/index.apt URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/administrator_guides/index.apt?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== --- continuum/trunk/continuum-docs/src/site/apt/administrator_guides/index.apt (original) +++ continuum/trunk/continuum-docs/src/site/apt/administrator_guides/index.apt Fri Nov 23 05:13:03 2012 @@ -12,9 +12,7 @@ Administrator's Guides * {{{./projectgroup.html}Managing Project Groups}} - * {{{./builder.html}Managing Builders}} - - * {{{./jdk.html}Managing JDKs}} + * {{{./builder.html}Managing Installations}} * {{{./buildEnvironment.html}Managing Build Environments}} Modified: continuum/trunk/continuum-docs/src/site/resources/images/buildenv-add.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/buildenv-add.png?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== Binary files - no diff available. Modified: continuum/trunk/continuum-docs/src/site/resources/images/buildenv-in-builddef.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/buildenv-in-builddef.png?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== Binary files - no diff available. Modified: continuum/trunk/continuum-docs/src/site/resources/images/buildenv-setup-jdk.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/buildenv-setup-jdk.png?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== Binary files - no diff available. Added: continuum/trunk/continuum-docs/src/site/resources/images/installation-envvar-edit.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/installation-envvar-edit.png?rev=1412755&view=auto ============================================================================== Binary file - no diff available. Propchange: continuum/trunk/continuum-docs/src/site/resources/images/installation-envvar-edit.png ------------------------------------------------------------------------------ svn:executable = * Propchange: continuum/trunk/continuum-docs/src/site/resources/images/installation-envvar-edit.png ------------------------------------------------------------------------------ svn:mime-type = image/png Modified: continuum/trunk/continuum-docs/src/site/resources/images/installation-tool-edit.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/installation-tool-edit.png?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== Binary files - no diff available. Added: continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice-envvar.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice-envvar.png?rev=1412755&view=auto ============================================================================== Binary file - no diff available. Propchange: continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice-envvar.png ------------------------------------------------------------------------------ svn:executable = * Propchange: continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice-envvar.png ------------------------------------------------------------------------------ svn:mime-type = image/png Modified: continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/installation-type-choice.png?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== Binary files - no diff available. Modified: continuum/trunk/continuum-docs/src/site/resources/images/installation-validation-failed.png URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/resources/images/installation-validation-failed.png?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== Binary files - no diff available. Modified: continuum/trunk/continuum-docs/src/site/site.xml URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/site.xml?rev=1412755&r1=1412754&r2=1412755&view=diff ============================================================================== --- continuum/trunk/continuum-docs/src/site/site.xml (original) +++ continuum/trunk/continuum-docs/src/site/site.xml Fri Nov 23 05:13:03 2012 @@ -78,8 +78,7 @@ - - +