Bitbucket - Mercurial

Configuring a Bitbucket Mercurial Source Repository

The instructions in this section apply to configuring a source repository for both Plans and Jobs.

To configure a Bitbucket Mercurial source repository:
If you are creating a new Plan or new Job, or have come from the Editing a Plan or Editing a Job topics, start at step 4.

1. Navigate to the source repository settings for a Plan or Job, as described on Specifying the Source Repository for a Plan and Specifying the Source Repository for a Job respectively.
   
2. Enter the details for the BitBucket repository as described below:
   • 'Use Plan's Repository' (Only available when configuring a Job) — Select this option if you wish to use the 'default source repository' of the Plan to which your Job belongs. If you select this option, you do not need to configure any further source repository options below, although if you are creating a new Job, continue with the Builder Configuration section of Creating a New Job.
   • 'Repository' — Select 'Bitbucket'.
   • 'Username' — Type the username required to access the Bitbucket account. It will be also used to access chosen repository.
   • 'Password' — Type the password you want to access the Bitbucket account. It will be also used to access chosen repository.
   • 'Repository' — Select 'My Repositories' to let Bamboo look up your repositories automatically, or select 'URL' to manually specify the repository URL.
     • If 'My Repositories' is selected, click 'Load Repositories' to load the repositories for the username entered above, then select the 'Repository' and 'Branch' that you want to check out code from.
     • If 'URL' is selected, enter the 'Repository URL' – This is the full path to your Bitbucket repository (e.g. 'http://bitbucket.org/sinbad/ogre'). If you want to choose a branch to work on, other than the default branch, click 'Load Branches' and select the desired branch.
       Note, valid Repository URLs are of the form:
       • http://bitbucket.org/username/repository
       • https://bitbucket.org/username/repository
   • 'Command timeout' (Optional) — Type the number of minutes bamboo should wait for Bitbucket commands to finish. This is useful to cut hung Bitbucket processes. On the slower networks, you may consider increasing the default timeout to allow Bamboo to make an initial clone of mercurial repository.
   • 'Verbose logs' — Turns on --verbose and --debug options in hg commands and pass the output to build logs. Use that option if you encounter problems in Bamboo Mercurial behaviour.

3. Common Repository Configuration (Only available when configuring an existing Plan/Job)

   • 'Force Clean Build:' (Optional) — 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:' (Optional) — 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:' (Only available when configuring a Plan) — 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.
   • 'Web Repository:' — Select the type of web repository ('None', 'Generic Web Repository', 'Mercurial Web Repository', 'FishEye') to be associated with this build. You will be able to view code changes related to your build via the build results.
     Only a subset of Web Repository options are available for your chosen repository type.
     • If 'Generic Web Repository' is selected:
       • '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.
     • If 'Mercurial Web Repository' is selected:
       • 'Mercurial Web Repository Viewer Scheme' — Choose between using the BitBucket Web Repository Scheme (if you use BitBucket) or Mercurial's own default web server (Default Web Repository Scheme (hgserve)).
     • If 'FishEye' is selected:
       • '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.

   • 'Build Strategy' (Only available when configuring a Plan) — 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.
     You may need to configure other options specific to your chosen build strategy.
     If you select Manual & dependent builds only when creating a new Plan, an initial build will not automatically be run. You can force an initial build to be executed automatically by adding the fire.initial.build.for.manual.strategy to your bamboo.cfg.xml file as described in Configuring System Properties.
4. Click the 'Save' button to save your changes.

Screenshot above: Source Repository — Bitbucket

Appendix - Build Strategies

Notes

• If you wish to build plans on your server and remote agents using a Mercurial repository, you need to specify the location of the Mercurial hg client application for your Bamboo server and for each remote agent using Mercurial. These locations are set by specifying:
  • a mandatory local server Mercurial capability for your Bamboo server and
  • agent-specific remote Mercurial capabilities for each of your remote agents using Mercurial.
  You will not be able to create Plans/Jobs that use a Bitbucket Mercurial repository without specifying the shared local Mercurial capability first. Read more about configuring a Mercurial capability.

Related Topics

Specifying the Source Repository for a Plan
Specifying the Source Repository for a Job