This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

The instructions on this page describe how to create a completely new Plan, i.e. not cloning an existing Plan or importing a Plan from Maven 2.

A Plan defines everything about your entire build process. Plans:

  • consist of one or more Jobs, which are organised into one or more Stages;
  • contains a single 'Default Job' in a single Stage, after creating a new Plan;
  • define default settings for what gets built by Jobs in the Plan (i.e. the 'default source repository');
  • define how the Plan's build is triggered;
  • define who will be notified of the Job's build result;
  • define who has permission to view and perform various actions on the Plan and its Jobs.

Every plan belongs to a Project.

Projects and plans can only be configured by Bamboo administrators (see Creating a Plan).

On this page:

Step 1. Create a New Plan

When you create a new Plan, you can define everything about your build process, including what gets built, how the Plan's Build is triggered and what Jobs are executed.

On the 'Create a New Plan' page, complete the options in the following sections to create your Plan:

  1. Start the Create Plan wizard as described on Creating a Plan and click 'Create a New Plan'.
  2. In the Plan Detailssection, enter or select the relevant items for the following fields:
    • Project — Select an existing project to which this Plan will belong. If this field is not available (because no projects have yet been defined on your Bamboo server) or you select 'New Project', complete the following fields:
      • Project Name — Enter a name for a new project or select an existing project. The plan which you create on this page will be associated with this project.
      • Project Key — Enter a unique key for this project or select an existing project key.
    • Plan Name — Enter a name for the new Plan.
    • Plan Key — Enter a unique key for the new Plan.
    • Plan Description — Enter a short sentence to describe this Plan.
  3. In the Source Repository section, specify a source repository configuration that will initially be used for building this Plan's Default Job and also defines the default source repository (or Plan's repository), which Jobs in this Plan can inherit.
    For details, refer to the following source repository configuration procedures, since many of these fields and options change depending on the 'Repository' you select:
  4. In the Build Strategysection, select or enter the relevant items for the following fields:
    • Build Strategy — Choose one of the Build Strategy options (listed below), which will be used for triggering the execution of this plan.
      (warning) You may need to configure other fields specific to your chosen build strategy.
  5. Click 'Configure Tasks' to go to the second step of creating your Plan.

Step 2. Configure Tasks for the New Plan

When a new Plan is created, a Default Job is also created as part of the Plan. Before you create your Plan, you need to configure the Tasks for the Default Job. You can add more Tasks to the Default Job after the Plan is created, as well as create new Jobs.

  1. On the 'Configure Tasks' screen, click 'Add Task' to add a task to the new Plan.
  2. Click the desired Task type in the 'Task Types' window.
  3. Fill out the details for the Task. The fields and options will be different depending on the executable that you chose in the Task Types window. See the following documentation for specific instructions on each executable:
  4. In the Enable this plan section, choose whether or not to enable this Plan. Enabling the Plan instructs Bamboo to commence executing builds of the Plan based on the Plan's Build Strategy (defined above). To enable this Plan, select the 'Yes please!' check box.
  5. Click the 'Create' button to create the Plan and the Plan's Plan Summary page will be displayed.
    (info) When you next return to the Dashboard (by clicking 'Home' in the top left of the page), your new Plan (and new Project, if applicable) will be displayed in the 'All Projects' list. Bamboo will also automatically run an initial build for your new Plan, unless you have opted for the Manual & dependent builds only Build Strategy.

If you wish to configure more Plan options, please refer to Editing a Plan.

Screenshots above: Creating a new Plan - Plan configuration and Job configuration (click to view gallery)

Notes

Related Topics

Creating a Plan
Cloning an Existing Plan
Importing a Plan from Maven 2

  • No labels