The instructions on this page describe how to configure a GitHub source repository. | On this page: |
Configuring a GitHub Source Repository
Navigate to the source repository settings for a Plan or Job, as described on Specifying the Source Repository for a Plan. Choose to add a new or edit an existing repository and select Github in the Source Control drop-down.
Once you've added your Github username and password and clicked Load Repositories, you will have the following options to specify the source repository for your plan:
Repository | Bamboo will retrieve all repositories you have explicit permissions to. Pick one of the repositories. | |
Branches | Pick a branch if you want to checkout code from a branch other than the master branch. | |
Use shallow clones | Select this setting to allow Bamboo to perform shallow clones (i.e. history truncated to a specified number of revisions). This should increase the speed of the initial code checkouts, however if your build depends on the full repository history, we recommend that you do not use this option. Shallow clones are enabled by default. |
Common Repository Configuration
Force Clean Build | You can force Bamboo to remove the source directory and check it out again prior to the Plan/Job build being built by selecting this option. Please note that this will greatly increase the time it takes to complete a build. | ||
Clean working directory after each build | You can force Bamboo to remove the source directory after the Plan/Job is completed building by selecting this option. Please note that this may increase build times but saves on disk space. | ||
Include/Exclude Files | You can specify a particular inclusion or exclusion pattern for file changes to be detected. If you select an option other than 'None', the following field will appear: File Pattern — The regular expression for file changes which you wish to include/exclude. The regex pattern must match the file path in the repository. Visit sub page for a few examples. | ||
Web Repository | Generic Web Repository | Web Repository URL — If your source repository can be accessed via a web browser, you can specify the URL of the source repository here. If you specify a Web Repository URL, then links to relevant files will be displayed in the 'Code Changes' section of a build result. Web Repository Module — The repository name of the Plan/Job, if the above Web Repository URL points to multiple repositories. | |
Mercurial Web Repository | Choose between using the BitBucket Web Repository Scheme (if you use BitBucket) or Mercurial's own default web server Default Web Repository Scheme (hgserve). | ||
FishEye | FishEye URL — The URL of your FishEye repository (e.g. ' Repository Name — The name of your FishEye repository (e.g. ' Repository Path — The path for your FishEye repository (e.g. '
| ||
Build Strategy | Choose one of the build strategy options (listed below), which will be used for triggering the execution of this Plan. You can change the Build Strategy at a later point in time as required. |
Screenshot above: Source Repository — GitHub
Notes
Related Topics
Specifying the Source Repository for a Plan
Specifying the Source Repository for a Job
Git