Documentation for Bamboo 4.0.x. Documentation for earlier versions of Bamboo is available too.

The instructions on this page describe how to configure Bamboo to use a GitHub source repository.

Related pages:

Configuring a GitHub source repository

To add a new GitHub repository, navigate to the source repository settings for a plan or job, as described on Specifying the source repository.

  1. Either click Add Repository to add a new repository, or edit an existing repository configuration.
  2. Choose GitHub from the Source Repository list.
  3. Enter a Display Name to help identify the repository in Bamboo.
  4. Enter your GitHub Username and Password.
  5. Click Load Repositories.
  6. You can configure the following advanced options for a GitHub source repository for your plan:

Advanced Options

Use submodulesSelect to enable submodules support if these are defined for the repository. If native GitHub capability is not defined for agent submodules support will be disabled.
Command timeoutThis is useful to stop hung Bitbucket processes. On slower networks, you may consider increasing the default timeout to allow Bamboo time to make an initial clone of the GitHub repository.
Verbose logsTurns on --verbose and --debug options in hg commands and passes the output to build logs. Use this option if you encounter problems with GitHub in Bamboo.
Enable Quiet PeriodSpecifies a delay after a single commit is detected before the build is started. This allows multiple commits to be aggregated into a single build.
Include/Exclude Files

Allows you to specify the files that Bamboo should, or should not, use to detect changes.

Enter into File Pattern a regular expression to match the files that Bamboo  includes or excludes. The regex pattern must match the file path in the repository. See sub page for examples.

Exclude ChangesetsEnter a regular expression to match the commit messages for changesets that should not start a build.
Web Repository 

If your repository can be viewed in a web browser, select the repository type.

This allows links to relevant files to be displayed in the 'Code Changes' section of a build result.

FishEye – specify the URL and other details for the repository:

    • FishEye URL — the URL of your FishEye repository (e.g. 'https://atlaseye.atlassian.com/').
    • Repository Name — the name of your FishEye repository (e.g. 'Bamboo'). This is effectively the alias for your repository path.
    • Repository Path — the path for your FishEye repository (e.g. '/atlassian/bamboo/').

How do I determine my Repository Path?

If you have previously run builds with changes from your repository, the easiest way of determining your repository path is to view the code changes and copy the path from the start of the path of one of the changed files, up to (but not including) the appropriate root directory. The root directories for repositories are the ones shown by FishEye when browsing a repository (e.g. trunk)). For example, if a code change listed /atlassian/bamboo/trunk/bamboo-acceptance-test/pom.xml, the path would be /atlassian/bamboo/.
If you have not previously run builds with changes from your repository, you will need to ask your FishEye administrator for the repository path indexed by FishEye.

  • No labels



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.