Compass Version1.2 Adding Build StepsA Build plan consists of a sequence of build steps. Each build step in the build plan will be executed in order synchronously until all build steps have successfully completed or until a build step fails and the build plan is halted. A build step consists of a script to execute, along with a set of options that are passed to the script and some additional configuration parameters to let Compass know how to execute the script. To add a build step to a build plan, click the 'Add Build Step' button on the build plan editor page. On a new build plan, after clicking the 'Add Build Step' button the build plan editor will look similar to this: The build step list table has 5 columns. The columns are briefly described in the following table and the Arguments, Details, and Ordering columns are covered in more detail in the next section: Build Plan Editor Column
| Description
| | Name | The Name column is optional. It allows the creator of a build plan to name each build step; this is useful when Compass displays build results. When a name is given, the name is used to identify each build step. If no name is given the name of the script that is executed is used instead. It is good practice to give each build step a name, especially for the case where a build plan consists of many build steps that execute the same script. | | Script | This drop down lets the user select which script to execute for the build step. Scripts can only be added and/or edited by site-wide administrators as a security precaution to ensure no-one uploads a malicious script. | | Arguments | The arguments textbox is the string that is passed to the selected script. Some scripts may require certain arguments to be passed in, while other will not accept any arguments. It all depends on what the script does and how it was implemented. When a new script is added by a site-wide administrator the script is accompanied by usage notes. Usage notes explain what the script does and any requirements the script has, including what it's arguments are. When adding arguments users can click the help icon in the Script column heading to see the usage notes for all scripts, or by clicking on the ellipses (...) users can see the usage notes for the currently selected script for that build step. | | Details | The Details column contains two buttons. One for accessing the Build Step Details Dialog and one for accessing the Build Step Defaults Dialog. The Details Dialog allows users to set 5 conditions for how the script will be executed and what to do when the script completes. The Defaults Dialog allows users to enter default values for arguments to a script that may otherwise be conditional on how the script was invoked. Both of these dialogs is covered in great detail in the next section. | | Ordering | The Ordering column allows users to move build steps up and down in the build plan as well as remove a build step from the build plan entirely. Build steps are executed synchronously in the order determined by the build plan. |
For complete documentation on how to use the Build Plan Details Dialog and the Build Plan Defaults Dialog please see the next section.
|
