01. Configuration Setup

Add/remove configuration

Configurations can be added or removed as indicated below:

When a configuration is newly added, a screen like below comes out to let you provide some basic information about the configuration:

Define repositories

Repositories need to be defined for QuickBuild to use the repositiries information to retrieve source code of your project. Multiple repositories can be defined, and you can select to checkout from all or only some of these repositories. Repositories defined here will override the repositories with the same name defined in ancestor configurations.

Define steps

Steps define the build process for given configuration. Steps can be accessed by clicking the Steps tab of a configuration. The step definition has two views:

• Will be Executed steps.

This gives a graphical view of which steps will be executed when you build this configuration. Following sample view screen demonstrates steps flow:

In this screen:

• • The initial step, the master step is a composite step which sequentially executes steps checkout, build with Ant, and publish. The publish step executes in parallel the child steps publish artifacts and publish JUnit reports.
  • Steps with a dashed border are defined in ancestor configurations. This means that step master, checkout, publish, and publish JUnit reports are inherited from the ancestor configurations.
  • Steps with a solid border are defined in the current configuration. This means that step build with Ant and publish artifacts are defined in the current configuration.
  • The step name link leads to detailed step definition.
  • New steps can be inserted into the execution flow by clicking one of the icons:
    • this icon only appears when the step is a composite step. It will first define a new step in the current configuration, and then modify the current step to contain the newly created step. If the current step is an inherited step, the step will be overridden to apply the particular step modifications without modifying the original step.
    • this icon will allow you to define a new step and add it before the current step. It will first define a new step in the current configuration, and then modify the parent step to contain the newly created step. If the parent step is an inherited step, it will be overridden to apply the particular step modifications without modifying the original step.
    • this icon will allow you to define a new step and add it after the current step. It will first define a new step in the current configuration, and then modify the parent step to contain the newly created step. If the parent step is an inherited step, it will be overridden to apply the particular step modifications without modifying the original step.
  • Only steps defined in current configuration can be deleted. Clicking the remove icon will first remove the step definition from the current configuration, and then modify the parent step to remove the step reference from the children list. If the parent step is an inherited step, it will be overridden to apply the modifications without modifying the original step.
  • Each step can be edited. If an inherited step is edited, it will be overridden to apply the modifications without modifying the original step.
  • If you want to adjust child execution order inside a sequential composite step, you'll need to edit the composite step, and modify the child order there.
  • You can introduce new steps into the execution flow by editing a composite step and add more steps. However, you can only choose from existing steps (either defined in the current configuration, or steps inherited from ancestor configurations). Various add icons in this view are convenient way to define new steps and then add them into the execution flow.
  • Following screen will be displayed if the default step is not defined in the current configuration and any of the ancestor configurations:
    
    In this case, the configuration can not be built because the initial step does not exist. To add the initial step, just click the add icon to define an appropriate initial step. Typically you add the initial step as an composite step, and then add appropriate child steps into the execution flow.

• All defined steps

This will display all defined steps in the current configuration. Please note that some steps defined here may not appear in the will be executed steps view, if they are not reachable from the initial step execution flow. At the same time, some steps that appear in the Will be executed steps view may not be defined here, because they are inherited from the ancestor configurations.