diff options
Diffstat (limited to 'doc/user/project/integrations/bamboo.md')
| -rw-r--r-- | doc/user/project/integrations/bamboo.md | 91 |
1 files changed, 49 insertions, 42 deletions
diff --git a/doc/user/project/integrations/bamboo.md b/doc/user/project/integrations/bamboo.md index 58cfd8c3a2f..38de8d9f1af 100644 --- a/doc/user/project/integrations/bamboo.md +++ b/doc/user/project/integrations/bamboo.md @@ -4,59 +4,66 @@ group: Integrations info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Atlassian Bamboo Service **(FREE)** +# Atlassian Bamboo integration **(FREE)** -GitLab provides integration with Atlassian Bamboo for continuous integration. -When configured, pushes to a project trigger a build in Bamboo automatically. -Merge requests also display CI/CD status showing whether the build is pending, -failed, or completed successfully. It also provides a link to the Bamboo build -page for more information. +You can automatically trigger builds in Atlassian Bamboo when you push changes +to your project in GitLab. -Bamboo doesn't quite provide the same features as a traditional build system when -it comes to accepting webhooks and commit data. There are a few things that -need to be configured in a Bamboo build plan before GitLab can integrate. +When this integration is configured, merge requests also display the following information: -## Setup +- A CI/CD status that shows if the build is pending, failed, or has completed successfully. +- A link to the Bamboo build page for more information. -### Complete these steps in Bamboo +Bamboo doesn't provide the same features as a traditional build system when +accepting webhooks and commit data. You must configure a Bamboo +build plan before you configure the integration in GitLab. -1. Navigate to a Bamboo build plan and choose **Configure plan** from the **Actions** - dropdown. +## Configure Bamboo + +1. In Bamboo, go to a build plan and choose **Actions > Configure plan**. 1. Select the **Triggers** tab. -1. Click **Add trigger**. -1. Enter a description such as **GitLab trigger**. -1. Choose **Repository triggers the build when changes are committed**. +1. Select **Add trigger**. +1. Enter a description like `GitLab trigger`. +1. Select **Repository triggers the build when changes are committed**. 1. Select the checkbox for one or more repositories. -1. Enter the GitLab IP address in the **Trigger IP addresses** box. This is a - list of IP addresses that are allowed to trigger Bamboo builds. +1. Enter the GitLab IP address in **Trigger IP addresses**. These IP addresses + are allowed to trigger Bamboo builds. 1. Save the trigger. -1. In the left pane, select a build stage. If you have multiple build stages - you want to select the last stage that contains the Git checkout task. +1. In the left pane, select a build stage. If you have multiple build stages, + select the last stage that contains the Git checkout task. 1. Select the **Miscellaneous** tab. -1. Under **Pattern Match Labeling** put `${bamboo.repository.revision.number}` - in the **Labels** box. -1. Save - -Bamboo is now ready to accept triggers from GitLab. Next, set up the Bamboo -service in GitLab. - -### Complete these steps in GitLab - -1. Navigate to the project you want to configure to trigger builds. -1. Navigate to the [Integrations page](overview.md#accessing-integrations) -1. Click **Atlassian Bamboo**. -1. Ensure that the **Active** toggle is enabled. -1. Enter the base URL of your Bamboo server. `https://bamboo.example.com` -1. Enter the build key from your Bamboo build plan. Build keys are typically made - up from the Project Key and Plan Key that are set on project/plan creation and - separated with a dash (`-`), for example **PROJ-PLAN**. This is a short, all - uppercase identifier that is unique. When viewing a plan in Bamboo, the - build key is also shown in the browser URL, for example `https://bamboo.example.com/browse/PROJ-PLAN`. -1. If necessary, enter username and password for a Bamboo user that has +1. Under **Pattern Match Labeling** enter `${bamboo.repository.revision.number}` + in **Labels**. +1. Select **Save**. + +Bamboo is ready to accept triggers from GitLab. Next, set up the Bamboo +integration in GitLab. + +## Configure GitLab + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Settings > Integrations**. +1. Select **Atlassian Bamboo**. +1. Ensure the **Active** checkbox is selected. +1. Enter the base URL of your Bamboo server. For example, `https://bamboo.example.com`. +1. Enter the [build key](#identify-the-bamboo-build-plan-build-key) from your Bamboo + build plan. +1. If necessary, enter a username and password for a Bamboo user that has access to trigger the build plan. Leave these fields blank if you do not require authentication. -1. Save or optionally click **Test Settings**. **Test Settings** - actually triggers a build in Bamboo. +1. Optional. To test the configuration and trigger a build in Bamboo, + select **Test Settings**. +1. Select **Save changes**. + +### Identify the Bamboo build plan build key + +A build key is a unique identifier typically made up from the project key and +plan key. +Build keys are short, all uppercase, and separated with a dash (`-`), +for example `PROJ-PLAN`. + +The build key is included in the browser URL when you view a plan in +Bamboo. For example, `https://bamboo.example.com/browse/PROJ-PLAN`. ## Troubleshooting |