This page describes how to use Bamboo to get rapid feedback on your Java project. The example on this page builds a Bamboo plan where a developer commits code and Bamboo responds by:
- Connecting to the code repository.
- Checking out the source code.
- Compiling the code
- Running unit and integration tests
- Reporting back test results
On this page:
Information you need before you begin
This tutorial assumes you are using Bamboo OnDemand rather than Bamboo installed on your local network. This allows the tutorial to make some basic assumptions about the resources available to Bamboo. You can still use the tutorial if you are using Bamboo on a local network. You just need to make sure you or your company administrator have properly installed and configured Bamboo for running plans.
This tutorial relies on you having an individual Bitbucket account. If you don't have one, it only takes minutes to create one. You can always delete it after you are done.
Step 1. Create a project and plan
1. Create a new project
A Bamboo plan defines the details of your continuous integration workflow. You use a plan to identify the source code repository, specify the tasks to run in your build, and when to trigger a build. Each plan belongs to a project. You can add a plan to an existing project or create a new project. In this example, you create both a new project and a new plan in that project.
- Log into your Bamboo instance as a user with permissions to create plans.
- Choose Create > Create a New Plan from the menu bar.
Every plan belongs to a project. We don't have a project yet, so choose Project > New Project, and enter details for both the project and plan.
| Project | New Project |
|---|---|
| Project Name | TestProject |
| Project Key | TP |
2. Configure the plan details
Bamboo needs to know the Plan name, Plan key and a brief description of what the plan is for. See Configuring plans for more details.
| Plan name | Tutorials |
|---|---|
| Plan key | TUT |
| Description | Build Atlassian tutorials |
3. Choose a source repository
Bamboo needs to know where the source code repository is located, and needs access to the repo so that it can check out the code when it runs a build. See Connecting to code repositories for more details.
| Source Repository | Bitbucket |
|---|---|
| Username | Your Bitbucket username |
| Password | Your Bitbucket password |
| Repository | atlassian_tutorial/hellworld (git) |
| Branch | master |
| Use shallow clones | Set this checkbox |
4. Triggering the build
We can choose how Bamboo gets triggered to run the plan build:
| Trigger type | Repository triggers the build when changes are comitted |
|---|---|
| Trigger IP | Optionally add an IP address for your repository |
See Triggering builds for more details.
Step 2. Configure tasks
Each plan needs to have at least one task specified. Tasks do the real work of the plan.
The source code checkout task
A newly created plan has a default Source Code Checkout task that gets the source code from the source repository specified earlier.
See Checking out code for details.
The builder task
We also want to compile the code, and run the unit and integration tests. We'll add a builder task to the Bamboo plan to do that. We assume that your project already has a build process set up that Bamboo can call upon.
Click Add Task, then Builder and choose the task that matches the build tool for your project. Expand one of the following sections to see configuration details specific to that builder task:
See http://ant.apache.org/manual/index.html for information about Ant.
Bamboo also supports Maven 1.0 and Maven 2.0.
See http://maven.apache.org/ for information about Maven.
See http://grails.org/doc/latest/guide/index.html for information about Grails.
Note that:
- A build tool needs to be installed on the Bamboo server machine before you can use the Bamboo task.
- There are plugins available for Bamboo that add build tasks for other tools, such as Gant and Gradle. See https://plugins.atlassian.com/plugin/details/27818?versionId=851052 for details.
Getting the test results
Your tests will be run when the builder task compiles the code. Each of the builder tasks above has a section to tell Bamboo to expect test results and where to look for them. You can specify a custom results location if your project directory doesn't use the conventional structure.
See Jobs and tasks for details.
Go!
Enable the plan, and click Create.
You should see the plan run. The 'Plan Summary' tab will report whether the build succeeded or not.
Tests in the appropriate directory in the source code repository will be run automatically as part of the build, and the test results will be displayed in Bamboo.
Now, whenever you commit a change to the repository, Bamboo will build your source code and report on your test results.
Get feedback
Bamboo displays a summary of the results of the build on the dashboard.
You can get further information about the build in the following ways:
- Build results for one or more plans can be displayed on a wallboard.
- You can get notifications about build results sent to you by email, IM and RSS feed.
- You can get build statistics about plans, and about developers contributing code to the build.
- You can drill down into the results to see the code changes that triggered the build, and the tests that were run for that build.
See Getting feedback for details.