perforce

If you are creating a new plan, start at step 5.

1. Click 'Home' to go to the Dashboard.
2. Click the 'All Plans' tab.
3. Locate the plan in the list and click this icon:
4. The 'Configuration' tab will be displayed. Click the 'Source Repository' sub-tab.
5. The 'Source Repository' sub-tab will be displayed. Complete the fields as follows:
   
6. Perforce Configuration
   • 'Repository' — select 'Perforce'.
   • 'Port' — Type either the port to which the Perforce client will connect, or the Perforce server itself. This is the Perforce P4PORT environment variable that tells Bamboo which p4d (Perforce server) to use.
   • 'Client' — The name of the Perforce Client Workspace which Bamboo will use. The Client Workspace determines which portions of the depot are visible in your Workspace Tree.
     Do not create two plans that use the same client (e.g. one client set to manage, the other client set to not manage). This setup will create major issues in your builds.

     Running Bamboo with Perforce prior to Bamboo 2.0.7

     A known issue exists when running Bamboo with Perforce prior to Bamboo 2.0.7 (See BAM-2866 and BAM-2849). If you change the name of your Perforce client (i.e. via an update) without updating your Perforce configuration in Bamboo, Bamboo will not be able to find the Perforce client to run against. Perforce will then create a default client in your running directory. This can lead to situtations where Bamboo will attempt to clear out data from your running directory (e.g. force build). To avoid this problem, ensure that you update the 'Client' in your Perforce configuration whenever you change your Perforce client.

   • 'Depot' — The client view of the depot that contains the source-code files for this plan. This is typically in the form //<clientname>/<workspace_mapping>/... For details please see the Perforce User's Guide.
     • Bamboo sets the client root to its working directory, which means that code will be checked out to the 'working directory/<workspace_mapping>' location. Please take note of this, when specifying the 'Artifact Copy Pattern' for your Build Artifacts.)
   • 'Username' — (Optional) The Perforce username that Bamboo will use when it accesses the server ('Port'). Leave this field blank if you want Bamboo to use the default Perforce user (i.e. the OS username).
   • 'Password' — (Optional) Type the password required by the Perforce username (if applicable).
   • 'Change Password' — (This field will only appear after you have saved the plan) Select this check-box if you want to change the password that is used to access the Perforce repository.
   • 'Let Bamboo manage your workspace' — This field indicates whether you want Bamboo to manage your workspace or not.

     Please be aware of the following implications of letting/preventing Bamboo from managing your workspace:
     If you let Bamboo manage your workspace,

     1. • We recommend this configuration if your plans will be running on many different machines or different operating systems, as Bamboo sets the client root for you.
        • Bamboo will make configuration changes to the Client Workspace to manage builds (e.g. Bamboo will modify the host and root). You need to ensure that you enter a Client Workspace in the 'Client' field that will be used solely for Bamboo.
        • Under this configuration, you should configure one client per plan to avoid conflicts when updating the client root.
          

     If you do not let Bamboo manage your workspace,

     1. • We recommend this configuration if you wish to reuse your client for several plans, as Bamboo will retrieve the client root directory from Perforce and use it to run builds.
          Setting the client root in Perforce: We strongly recommend that you choose a directory that is dedicated for Bamboo's use only, when you are specifying the client root in your Perforce repository. This directory may get cleaned (i.e. files and sub-directories deleted) if you choose to force clean builds.
        • Under this configuration, you need to ensure that the client root directory exists on all machines that the plan will be built on.
        • Please note that alternate roots does not currently work in Bamboo. See issue BAM-2377 for further details.
   • 'Enable Quiet Period:' — Select this setting to set Quiet Period parameters for the build plan.
   • 'Quiet Period:' — This field will only display if 'Enable Quiet Period:' has been selected. This setting is used to avoid starting a build while someone is in mid-checkin. Bamboo will only initiate a build for this plan when no more changes are detected within the Quiet Period following the last known change. Type the number of seconds Bamboo should wait.
   • 'Maximum Retries:' — This field will only display if 'Enable Quiet Period:' has been selected. You can specify how many times Bamboo should check for new changes using the Quiet Period parameter before initiating a build. For example, if you have set the 'Quiet Period' to '10' seconds then Bamboo will check if a checkout has occurred in the last 10 seconds. If you have then specified 'Maximum Retries:' as '5', then Bamboo will perform this check five times before initiating the build, regardless of any activity during the Quiet Period of the last check.
     
7. Common Repository Configuration

   • 'Force Clean Build' (Optional) — You can force Bamboo to remove the source directory and check it out again prior to each build by selecting this option. Please note that this will greatly increase the time it takes to complete a build.
   • 'Include/Exclude Files' — (Optional) You can specify a particular inclusion or exclusion pattern for file changes to be detected.
   • 'File Pattern' — (Optional) The regular expression for file changes which you wish to include/exclude.
   • 'Web Repository URL' --- (Optional) You can specify the URL of the plan's browsable repository. If you specify a Web Repository URL, then links to relevant files will be displayed in the 'Code Changes' section of a build result.

     Linking to your FishEye project

     If you are using Atlassian's FishEye, you can link your Bamboo plan to your FishEye project. Enter the URL of your FishEye project in the 'Web Repository URL' (e.g. https://svn.myrepo.com/fisheye/browse/myproject) and the Code Changes' section of a build result will display links to your files via FishEye.

   • 'Web Repository Module' — (Optional) The plan's repository name, if the above Web Repository URL points to multiple repositories.
   • 'Build Strategy' — The default value, 'Poll the repository for changes', is a convenient option that requires no additional configuration. A number of other options are available; for details, please see Triggering a Build. You can change the Build Strategy over time as required. The rest of the fields on this tab will vary depending on which Build Strategy you select.
8. Click the 'Save'/'Done' button if you are editing an existing plan; or if you are creating a new plan, click the 'Next' button to go to the next page:
   Specifying a Plan's Builder