GitHub

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.

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

Advanced Options

Use submodules	Select 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 timeout	This 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 logs	Turns 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 Period	Specifies 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 Changesets	Enter 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.