Creating a Plan

Creating a Plan

始める前に

• The 'Create Plan' or 'Admin' global permission is required to create new Plans.

To create a Plan in Bamboo:

1. Click the Create Plan link in the top navigation bar. The Create Plan introductory page is displayed with the following options:
   • Create a New Plan
   • Clone an Existing Plan — This option only appears if you have the 'Clone' and/or 'Admin' plan permission for at least one Plan on the Bamboo server.
   • Import a Maven 2 Project — This option only appears if Maven 2 has been installed.
2. Click one of the options to start creating your Plan. Each of these options is described in the sections below.

Screenshot above: Create Plan Introductory Page

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. 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.
2. 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 (from step 4), since many of these fields and options change depending on the 'Repository' you select:
   • CVS
   • Subversion
   • perforce
   • Mercurial
     
3. In the Build Strategy section, 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.
     You may need to configure other fields specific to your chosen build strategy.
4. In Builder Configuration section, specify the builder configuration that will be used for building the Plan's Default Job. The builder that you select will become one of this Job's requirements. For details please see Configuring a Job's Requirements.
   Refer to the following documentation on Bamboo's builders (from step 2) for details about these options, since many of these fields and options change depending on the 'Builder' you select.
   • ant
   • Custom Command Builder
   • devenv.com
   • Grails
   • Maven
   • NAnt
   • PHPUnit
   • Script Builder
     
5. 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.
6. Click the 'Create' button to create the Plan and the Plan's Plan Summary page will be displayed.
   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.

注意

• You can configure Bamboo to automatically start an initial build for a new Plan, even if you have selected 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.

Clone 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. 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.
   Only Plans for which you have the 'Clone' and/or 'Admin' plan permission are shown.
2. 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.
3. 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.
4. Click the 'Create' button to create the Plan and the Plan's Plan Summary page will be displayed.
   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.

注意

• 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.

Import a Maven 2 Project

If you have the details for a Plan set up in your Maven 2 project, Bamboo can check out and parse the pom.xml from this project and create a new Plan using the details from it. This feature will not work with Maven 1 projects.

*To create a new Plan from a Maven 2 pom.xml file:*

1. 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 (from step 4), since many of these fields and options change depending on the 'Repository' you select:
   • CVS
   • Subversion
   • perforce
   • Mercurial
     If you specify a CVS or Subversion source code management system, then the location you configure in the respective CVS Root or Repository URL fields should contain your Maven 2 project's pom.xml file.
2. Click the 'Import' button to display the Confirm Plan Details page.
3. On the Confirm Plan Details page, some of the fields should already have been populated with information from your pom.xml file. Confirm the following (making any necessary modifications):
   • Plan Details in the top section of the page — for more information about these fields, refer to the Plan Details section in the Create a New Plan procedure above.
   • Source Repository — for more information about these fields, refer to step 1 of this procedure.
     
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 'Confirm' button to save your Plan configuration so far and the Builder tab of the Plan's Default Job is displayed.
6. Select the type of 'Builder' that will be used for building this Default Job.
   In practice, you should leave the Builder option set to your 'Maven 2' builder and configure the options on this page as described in Bamboo's Maven configuration documentation. You can select another builder here but this would only be useful if your Maven 2 project's pom.xml depended on a non-Maven 2 builder. If you do need to specify a non-Maven 2 builder, refer to the Builder Configuration section in the Create a New Plan procedure above.

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

注意

• Security Manager settings too strict — Please note, during the Maven import process, the project file (pom.xml or other specified by the user) is analysed using the maven-embedder library. The parent POM files will be examined in the local repository or downloaded from network repositories. In order to reuse Maven's credentials for the network repositories, Bamboo requires internal access to the maven-embedder. If your JVM's or web container's SecurityManager settings are too strict, this process will fail and you will see an error similar to the following in your Bamboo logs:

  "Problem while initializing Maven Embedder. Probably Security Manager settings are too strict, refer to http://tomcat.apache.org/tomcat-6.0-doc/security-manager-howto.html"

  If your imported Maven project file uses repositories that require credentials (i.e. not public or local), you will need to adjust the SecurityManager settings for your JVM or web container appropriately for the import to work.
• By default, all Plans created by importing a Maven 2 project use the Polling the Repository for changes Build Strategy, below, which you can later change when editing this Plan. You can configure Bamboo to automatically start an initial build for a new Plan, even if you have selected 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.

Appendix - Build Strategies