Bamboo uses the 'Source Code Checkout' task to check out repositories into the working directory on the agent.
Using this task it is also possible to:
- Check out multiple repositories to a custom directory path in the working directory
- Specify multiple checkouts that occur at different stages of the build. (This can be achieved by simply adding another 'Source Code Checkout' task to a job at any point in the plan.)
To configure a new Source Code Checkout task:
- Navigate to the job that should perform the task, as described on Specifying the source repository.
- 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.
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 Specifying the source repository 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. - Click Add Repository, at the bottom of the 'Task' screen, to add another repository to the task.
- 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 Connecting to code repositories page.

4 Comments
Brian Murray
Oct 24, 2012I need to checkout to an absolute path on C:. I am prevented from doing so. What is the most robust way ot creating a relative path - can I use environmental variables?
ishabtay
Feb 26, 2013According to BAM-1640 - Getting issue details... STATUS , it should be possible to provide a custom SVN revision number to check out, as of Bamboo 4.3. Using Bamboo 4.4, I can see no such option in the "Source Code Checkout" task. How, then, can that be accomplished?
Gagan Deol
Feb 20, 2014While checking out source code from repository, I need that one file should be created which contains all files checked out with its revision. How Can I achieve that. Please answer ASAP.
user-cc56b
Jul 03, 2014Not being able to checkout only a sub-path of the repository sends Bamboo years behind TeamCity.
If my repository contains a
tests/folder which is useful for other purposes, I'm forced to:It's a shame, really.