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 clone an existing Plan to create a new Plan.

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;
  • 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:

Cloning an Existing Plan

When you clone an existing Plan, you make a copy of that Plan and its entire configuration.

On the 'Clone and Existing Plan' page, complete the options in the following sections to clone an existing Plan:

  1. Start the Create Plan wizard as described on Creating a Plan and click 'Clone an Existing Plan'.
  2. In the 'Plan to clone' section and dropdown, select the Plan you wish to clone. Plans are listed in the format 'Project Name - Plan Name' and are organised by Project.
    (info) Only Plans for which you have the 'Clone' and/or 'Admin' plan permission are shown.
  3. In the 'Plan Details' section, 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.
  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 the Plan you cloned uses the Manual & dependent builds only Build Strategy.

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

Screenshots above: Cloning an existing Plan

Appendix - Build Strategies

This table lists Bamboo's available build strategies that determine how the execution of a plan (i.e. a build) is triggered. Each build strategy has other options (listed at the far right of this table), which may also require configuration.

Build strategy option

Description

Reason for choosing

Related documentation

Polling the Repository for changes

Bamboo will 'poll' the source code repository for changes based on set intervals or a schedule. If Bamboo detects a change to any code in this repository, a build of this plan will be triggered.

This is the simplest option. However, this does mean that your SCM must service a 'check out' or 'update' command whenever it is polled, even if no code has changed in the repository.

Polling the Repository for Changes

The repository triggers the build when changes are committed

Bamboo will wait to receive a message from the source code repository (specified above) about any code changes in this repository. When Bamboo receives such a message, Bamboo will trigger a build of this plan.

This option minimises server load as message events are sent only when code changes to this repository are committed. However, you must configure your source code management system to send message events to Bamboo about code changes in this repository.

Repository Triggers the Build when Changes are Committed

Cron Based Scheduling

Bamboo will trigger a build of this plan based on a Cron expression.

This option allows you to schedule builds when server load is likely to be minimal, for example, outside office hours. Scheduled builds are triggered irrespective of any code changes in the source code repository.

Cron Based Scheduling

Single daily build

Bamboo will trigger a build of this plan once per day at a specified time.

This option is suitable if a build of this plan takes a long time to complete. Scheduled builds are triggered irrespective of any code changes in the source code repository.

Single Daily Build

Manual & dependent builds only

Bamboo only triggers a build of this plan when the user chooses this function manually or through a build dependency.

This option is suitable if a build of this plan will fail, perhaps due to source code problems of failing tests. This frees up Bamboo agents to build other plans which are less likely to fail.

Triggering a Plan Build Manually

Notes

  • You can configure Bamboo to automatically start an initial build for a new Plan, even if the Plan you cloned uses the Manual & dependent builds only Build Strategy. To do so, add the fire.initial.build.for.manual.strategy to your bamboo.cfg.xml file as described in Configuring System Properties.
Related Topics

Creating a Plan
Creating a New Plan
Importing a Plan from Maven 2

  • No labels





Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.