buildframework/helium/doc/src/manual/stage_final.rst.inc.ftl
changeset 628 7c4a911dc066
equal deleted inserted replaced
588:c7c26511138f 628:7c4a911dc066
       
     1 <#--
       
     2 ============================================================================ 
       
     3 Name        : stage_final.rst.inc.ftl
       
     4 Part of     : Helium 
       
     5 
       
     6 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     7 All rights reserved.
       
     8 This component and the accompanying materials are made available
       
     9 under the terms of the License "Eclipse Public License v1.0"
       
    10 which accompanies this distribution, and is available
       
    11 at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
    12 
       
    13 Initial Contributors:
       
    14 Nokia Corporation - initial contribution.
       
    15 
       
    16 Contributors:
       
    17 
       
    18 Description:
       
    19 
       
    20 ============================================================================
       
    21 -->
       
    22 
       
    23 .. index::
       
    24   single: Stage - Final operations
       
    25 
       
    26 Stage: Final operations
       
    27 =======================
       
    28 
       
    29 Final operation are steps which could happen at the workflow completion.
       
    30 
       
    31 
       
    32 Running a target at build completion
       
    33 ------------------------------------
       
    34 
       
    35 Helium offers the possibility to run a final target despite any error which could occur during the build.
       
    36 The configuration of the target is done using the **hlm.final.target** property.
       
    37 
       
    38 e.g:
       
    39 ::
       
    40    
       
    41    <property name="hlm.final.target" value="my-final-target" />
       
    42    
       
    43 
       
    44 Running action on failure
       
    45 -------------------------
       
    46 
       
    47 The signaling framework will automatically run all signalExceptionConfig in case of Ant failure at the
       
    48 end of the build. 
       
    49 
       
    50 This example shows how simple task can be run in case of failure: 
       
    51 ::
       
    52    
       
    53        <hlm:signalExceptionConfig id="signal.exception.config">
       
    54            <hlm:notifierList>
       
    55                <hlm:executeTaskNotifier>
       
    56                    <echo>Signal: ${r'$'}{signal.name}</echo>
       
    57                    <echo>Message: ${r'$'}{signal.message}</echo>
       
    58                    <runtarget target="build-log-summary" />
       
    59                </hlm:executeTaskNotifier>
       
    60            </hlm:notifierList>
       
    61        </hlm:signalExceptionConfig>
       
    62    
       
    63 
       
    64