Checking out code

You add the Source Code Checkout task to a job to configure a repository for use by just that job. For information about configure a repository for use by all the plan's jobs, or by all plans, see Linking to source code repositories.

By default, repositories are checked out to the Bamboo working directory. Using Source Code Checkout task you can:

• Check out multiple repositories to a custom directory path in the working directory.
• Specify multiple checkouts that occur at different stages of the build. (Simply add another Source Code Checkout task to a job at any point in the plan.)

To configure a new Source Code Checkout task:

1. Navigate to the job that should perform the task.
2. Click the Tasks tab, and select an existing 'Source Code Checkout' task in the tasks list, or add a new one using the Add Task button.

3. Configure the task:
   
   

   Task Description	Enter a description of the task, for display in Bamboo.
   Disable this task	Check, or clear, to selectively run this task.
   Repository	Select the desired repository. If you wish to add different types of repositories, they must have been previously defined on the plan's Source Repositories tab. See Linking to source code repositories for a list of supported SCMs.
   Checkout Directory	The location to which the contents of the selected repository will be checked out to when the task executes.
   Force Clean Build	Deletes the previously checked out directory and checks it out again prior to the next build. This may significantly increase build times.

4. Click Add Repository, at the bottom of the 'Task' screen, to add another repository to the task. 
5. Click Save.

Screenshot: Configuring a Source Code Checkout task

Notes

• A number of source repositories are supported 'out of the box', as described on the Linking to source code repositories page. 

• If you need to use a type of repository that is not supported, a number of third-party Source Repository plugin modules are available (e.g. ClearCase plugin). You can also write a Source Repository Module plugin to enable Bamboo to connect to your repository.