PageRenderTime 74ms CodeModel.GetById 26ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/CCNET/ForceBuildPublisher.html

https://github.com/aravindmc/CruiseControl.NET
HTML | 169 lines | 155 code | 14 blank | 0 comment | 0 complexity | fb212d5db387f995a6b476053bd48188 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.     <head>
    4. 

  4.         <title>CruiseControl.NET : ForceBuildPublisher</title>
    5. 

  5. 	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
    6. 

  6.         <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
    7. 

  7.     </head>
    8. 

  8. 

  9.     <body>
    10. 

  10. 	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
    11. 

  11. 		    <tr>
    12. 

  12. 			    <td valign="top" class="pagebody">
    13. 

  13. 				    <div class="pageheader">
    14. 

  14. 					    <span class="pagetitle">
    15. 

  15.                             CruiseControl.NET : ForceBuildPublisher
    16. 

  16.                                                     </span>
    17. 

  17. 				    </div>
    18. 

  18. 				    <div class="pagesubheading">
    19. 

  19. 					    This page last changed on Nov 30, 2010 by <font color="#0050B2">ccnet-doc-gen</font>.
    20. 

  20. 				    </div>
    21. 

  21. 

  22. 				    <h1><a name="ForceBuildPublisher-ForceBuilderPublisher"></a>Force Builder Publisher</h1>
    23. 

  23. 

  24. <p>The ForceBuildPublisher forces a build on a local or remote build server. It uses .NET Remoting to invoke a forced build on the CruiseControl.NET server at the specified URI.  <br/>
    25. 

  25. The forced build runs asynchronously, i.e. the ForceBuildPublisher does not wait for the forced build to finish. The ForceBuildPublisher is a great way to help [ Splitting the build ].  <br/>
    26. 

  26. An alternative to the ForceBuildPublisher is the <a href="Project Trigger.html" title="Project Trigger">Project Trigger</a>. The main difference is that the ForceBuildPublisher is placed in the configuration for the primary project, while the ProjectTrigger is is placed in the configuration for the dependent project.  </p>
    27. 

  27. 

  28. 

  29. <h2><a name="ForceBuildPublisher-Version"></a>Version</h2>
    30. 

  30. 

  31. <p>Available from version 1.0</p>
    32. 

  32. 

  33. <h2><a name="ForceBuildPublisher-Examples"></a>Examples</h2>
    34. 

  34. 

  35. <div class="code panel" style="border-style: solid;border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;background-color: #ADD6FF;"><b>Simple Example</b></div><div class="codeContent panelContent">
    36. 

  36. <pre class="code-xml"><span class="code-tag">&lt;forcebuild&gt;</span>
    37. 

  37.   <span class="code-tag">&lt;project&gt;</span>AcceptanceTestProject<span class="code-tag">&lt;/project&gt;</span>
    38. 

  38.   <span class="code-tag">&lt;serverUri&gt;</span>tcp://buildserver2:21234/CruiseManager.rem<span class="code-tag">&lt;/serverUri&gt;</span>
    39. 

  39.   <span class="code-tag">&lt;integrationStatus&gt;</span>Success<span class="code-tag">&lt;/integrationStatus&gt;</span>
    40. 

  40.   <span class="code-tag">&lt;enforcerName&gt;</span>Forcer<span class="code-tag">&lt;/enforcerName&gt;</span>
    41. 

  41. <span class="code-tag">&lt;/forcebuild&gt;</span></pre>
    42. 

  42. </div></div>
    43. 

  43. <div class="code panel" style="border-style: solid;border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;background-color: #ADD6FF;"><b>Example with Security</b></div><div class="codeContent panelContent">
    44. 

  44. <pre class="code-xml"><span class="code-tag">&lt;forcebuild&gt;</span>
    45. 

  45.   <span class="code-tag">&lt;project&gt;</span>AcceptanceTestProject<span class="code-tag">&lt;/project&gt;</span>
    46. 

  46.   <span class="code-tag">&lt;serverUri&gt;</span>tcp://buildserver2:21234/CruiseManager.rem<span class="code-tag">&lt;/serverUri&gt;</span>
    47. 

  47.   <span class="code-tag">&lt;integrationStatus&gt;</span>Success<span class="code-tag">&lt;/integrationStatus&gt;</span>
    48. 

  48.   <span class="code-tag">&lt;security&gt;</span>
    49. 

  49.     <span class="code-tag">&lt;namedValue name=<span class="code-quote">"username"</span> value=<span class="code-quote">"autobuild"</span> /&gt;</span>
    50. 

  50.     <span class="code-tag">&lt;namedValue name=<span class="code-quote">"password"</span> value=<span class="code-quote">"autobuild"</span> /&gt;</span>
    51. 

  51.   <span class="code-tag">&lt;/security&gt;</span>
    52. 

  52. <span class="code-tag">&lt;/forcebuild&gt;</span></pre>
    53. 

  53. </div></div>
    54. 

  54. 

  55. 

  56. <h2><a name="ForceBuildPublisher-ConfigurationElements"></a>Configuration Elements</h2>
    57. 

  57. 

  58. <table class='confluenceTable'><tbody>
    59. 

  59. <tr>
    60. 

  60. <th class='confluenceTh'> Element </th>
    61. 

  61. <th class='confluenceTh'> Description </th>
    62. 

  62. <th class='confluenceTh'> Type </th>
    63. 

  63. <th class='confluenceTh'> Required </th>
    64. 

  64. <th class='confluenceTh'> Default </th>
    65. 

  65. <th class='confluenceTh'> Version </th>
    66. 

  66. </tr>
    67. 

  67. <tr>
    68. 

  68. <td class='confluenceTd'> description </td>
    69. 

  69. <td class='confluenceTd'> Description used for the visualisation of the buildstage, if left empty the process name will be shown.   </td>
    70. 

  70. <td class='confluenceTd'> String </td>
    71. 

  71. <td class='confluenceTd'> No </td>
    72. 

  72. <td class='confluenceTd'> The task/publisher name. </td>
    73. 

  73. <td class='confluenceTd'> 1.5 </td>
    74. 

  74. </tr>
    75. 

  75. <tr>
    76. 

  76. <td class='confluenceTd'> dynamicValues </td>
    77. 

  77. <td class='confluenceTd'> The dynamic values to use for the task.   </td>
    78. 

  78. <td class='confluenceTd'> <a href="Dynamic Values.html" title="Dynamic Values">Dynamic Values</a> array </td>
    79. 

  79. <td class='confluenceTd'> No </td>
    80. 

  80. <td class='confluenceTd'> <em>None</em> </td>
    81. 

  81. <td class='confluenceTd'> 1.5 </td>
    82. 

  82. </tr>
    83. 

  83. <tr>
    84. 

  84. <td class='confluenceTd'> enforcerName </td>
    85. 

  85. <td class='confluenceTd'> Identification of a ForceBuildPublisher. This value is passed to the CCNetRequestSource attribute of the forced  project's build.   </td>
    86. 

  86. <td class='confluenceTd'> String </td>
    87. 

  87. <td class='confluenceTd'> No </td>
    88. 

  88. <td class='confluenceTd'> BuildForcer </td>
    89. 

  89. <td class='confluenceTd'> 1.0 </td>
    90. 

  90. </tr>
    91. 

  91. <tr>
    92. 

  92. <td class='confluenceTd'> environment </td>
    93. 

  93. <td class='confluenceTd'>   A set of environment variables set for commands that are executed.  <br clear="all" />  Each variable should be specified as <div class="code panel" style="border-style: solid;border-width: 1px;"><div class="codeContent panelContent">
    94. 

  94. <pre class="code-xml"><span class="code-tag">&lt;variable name=<span class="code-quote">"name"</span> value=<span class="code-quote">"value"</span> /&gt;</span></pre>
    95. 

  95. </div></div><br/>
    96. 

  96. .   </td>
    97. 

  97. <td class='confluenceTd'> <a href="Environment Variable.html" title="Environment Variable">Environment Variable</a> array </td>
    98. 

  98. <td class='confluenceTd'> No </td>
    99. 

  99. <td class='confluenceTd'>&nbsp;</td>
    100. 

  100. <td class='confluenceTd'>&nbsp;</td>
    101. 

  101. </tr>
    102. 

  102. <tr>
    103. 

  103. <td class='confluenceTd'> integrationStatus </td>
    104. 

  104. <td class='confluenceTd'> The condition determining whether or not the remoting call should be made. The default value is "Success" indicating that the specified build will be forced if the current build was successful   </td>
    105. 

  105. <td class='confluenceTd'> String - one of:
    106. 

  106. <ul>
    107. 

  107. 	<li>Success</li>
    108. 

  108. 	<li>Failure</li>
    109. 

  109. 	<li>Exception</li>
    110. 

  110. 	<li>Unknown</li>
    111. 

  111. 	<li>Cancelled</li>
    112. 

  112. </ul>
    113. 

  113. </td>
    114. 

  114. <td class='confluenceTd'> No </td>
    115. 

  115. <td class='confluenceTd'> Success </td>
    116. 

  116. <td class='confluenceTd'> 1.0 </td>
    117. 

  117. </tr>
    118. 

  118. <tr>
    119. 

  119. <td class='confluenceTd'> parameters </td>
    120. 

  120. <td class='confluenceTd'> The parameters to pass to the remote project.   </td>
    121. 

  121. <td class='confluenceTd'> <a href="Named Value.html" title="Named Value">Named Value</a> array </td>
    122. 

  122. <td class='confluenceTd'> No </td>
    123. 

  123. <td class='confluenceTd'> <em>None</em> </td>
    124. 

  124. <td class='confluenceTd'> 1.5 </td>
    125. 

  125. </tr>
    126. 

  126. <tr>
    127. 

  127. <td class='confluenceTd'> project </td>
    128. 

  128. <td class='confluenceTd'> The CCNet project to force build.   </td>
    129. 

  129. <td class='confluenceTd'> String </td>
    130. 

  130. <td class='confluenceTd'> Yes </td>
    131. 

  131. <td class='confluenceTd'> <em>n/a</em> </td>
    132. 

  132. <td class='confluenceTd'> 1.0 </td>
    133. 

  133. </tr>
    134. 

  134. <tr>
    135. 

  135. <td class='confluenceTd'> security </td>
    136. 

  136. <td class='confluenceTd'> The security credentials to pass through to the remote server.  <br clear="all" />These are only needed if the remote project has security applied. If credentials are passed to the remote server, then the enforcerName will be ignored. Valid security tokens are: "username" and "password" (this list may be expanded in future).   </td>
    137. 

  137. <td class='confluenceTd'> <a href="Named Value.html" title="Named Value">Named Value</a> array </td>
    138. 

  138. <td class='confluenceTd'> No </td>
    139. 

  139. <td class='confluenceTd'> <em>None</em> </td>
    140. 

  140. <td class='confluenceTd'> 1.5 </td>
    141. 

  141. </tr>
    142. 

  142. <tr>
    143. 

  143. <td class='confluenceTd'> serverUri </td>
    144. 

  144. <td class='confluenceTd'> The URI for the local or remote server managing the project to build. The default value is the default URI for the local build server.  <br clear="all" />This publisher only uses .NET Remoting for connecting to the remote server. As such, it cannot use the HTTP protocol for connecting.   </td>
    145. 

  145. <td class='confluenceTd'> String </td>
    146. 

  146. <td class='confluenceTd'> No </td>
    147. 

  147. <td class='confluenceTd'> tcp://localhost:21234/CruiseManager.rem </td>
    148. 

  148. <td class='confluenceTd'> 1.0 </td>
    149. 

  149. </tr>
    150. 

  150. </tbody></table>
    151. 

  151. 

  152. <div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Automatically Generated</b><br />
    153. 

  153. <p>Documentation generated on Tuesday, 30 Nov 2010 at 10:25:41 AM<br/>
    154. 

  154. Using assembly version 1.6.7805.1</p></td></tr></table></div>
    155. 

  155. 

  156. 				    
    157. 

  157.                     			    </td>
    158. 

  158. 		    </tr>
    159. 

  159. 	    </table>
    160. 

  160. 	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
    161. 

  161. 			<tr>
    162. 

  162. 				<td height="12" background="http://confluence.public.thoughtworks.org//images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
    163. 

  163. 			</tr>
    164. 

  164. 		    <tr>
    165. 

  165. 			    <td align="center"><font color="grey">Document generated by Confluence on Jan 23, 2011 08:52</font></td>
    166. 

  166. 		    </tr>
    167. 

  167. 	    </table>
    168. 

  168.     </body>
    169. 

  169. </html>
    170.