Linking to source code repositories

A crucial part of setting up your continuous integration build process is specifying the code repositories with which Bamboo will work. You can specify repositories at the following levels in Bamboo:

  • global – repositories are available to all plans in Bamboo.
  • plan – repositories are available to all jobs in the Bamboo plan.

The recommended approach is to set up linked source repositories at the global level, described below

Important changes to Linked repositories that affect usage and permissions

Linked repositories are now the preferred way to define and share repository configuration between plans in Bamboo. As a result, we've made two changes that you should be aware of:

  • When users create plans, they are only given the option to select from Linked repositories. This requires that users have the Create plan global permission.
  • Users will need the Create repository global permission in order to create Linked repositories. Note that this permission alone does not permit a user to create or edit a plan.

In the long term, Atlassian plans to deprecate the repository configuration defined against the plan. These configurations can be converted to Linked repositories by clicking Convert to linked repository in each plan's repository configuration page.

Link a source code repository for all Bamboo plans

Linked repositories are available globally to all plans and jobs configured on the Bamboo server. Doing this can save you from having to reconfigure the source repositories in multiple places if these ever change - any changes to a linked repository are applied to every plan or job that uses that repository. 

You need the Create plan or Admin global permission to configure linked repositories.

  1. From the Bamboo header select  > Build resources > Linked repositories.
  2. Select Add repository.
  3. Select your repository type from the available menu options. For configuration details for a particular repository type, please refer to one of the following pages:

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

Note that shared source repositories are no longer the preferred way to share repository configuration between plans. Use Linked repositories instead!

Configure a repository for a plan

When you create a new plan, the source repository you specify becomes the default. It is used by the plan's default job and can be used by other jobs added to this plan. Note that default repository is an essential concept when working with plan branches, refer to Using plan branches for more details.

  1. Navigate to the plan. See Configuring plans for instructions.
  2. Select Actions > Configure plan.
    • Select the Repositories tab to see all the repositories that have been added to the plan. 
    • Select a repository name in the list to edit its configuration details.
    • Select Add repository to configure a repository to be used by the plan.
      For configuration details for a particular repository type, please refer to one of the following pages:

In the long term, we plan to deprecate the repository configuration defined against a plan. These configurations can be converted to Linked repositories by selecting Convert to linked repository on each plan repository configuration page.

Last modified on Sep 6, 2023

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.