Tutorial: Bamboo Specs YAML stored in Bitbucket Server
This guide will show you how you can store Bamboo Specs in a Git repository on Bitbucket Server. This approach allows to automatically build and execute Bamboo Specs on every push you make to a Git repository.
Related links
Before you begin
- Make sure you have the following software installed:
- Bamboo 6.9 or later
- Bitbucket Server 5.0 or later
- Set up an application link between Bamboo and Bitbucket Server. See Integrating Bamboo with Bitbucket Data Center.
Step 1: Create a Git repository in Bitbucket Server and clone it locally
- In Bitbucket Server, open the Projects page.
- Click Create project.
- Select
Bamboofor project name and key and click Create project.
You see that the project has no repositories. - Click Create repository.
- Give your new repository the name
tutorial, and click Create repository.
You've just created a new empty repository. Use the git clone command to create a clone on your computer. For example:
git clone http://admin@localhost:7990/scm/bamboo/tutorial.gitStep 2: Create Bamboo Specs YAML config
Go to the empty Git repository you cloned in step 1:
cd tutorial mkdir bamboo-specs cd bamboo-specs echo > bamboo.ymlUse any of the templates we've prepared for your in Bamboo YAML Specs Reference or write YAML definition on your own with Bamboo Specs YAML format./
It's important to save your Bamboo Specs YAML definition in the ${repo-home}/bamboo-specs/bamboo.yml or bamboo.yaml file under the repository root.
--- version: 2 plan: project-key: MARS key: ROCKET name: Build the rocket stages: - Build hull: - Build Build: tasks: - script: - echo 'Hello World!'Add created
bamboo-specsdirectory to VCS and push changes to the server:git add bamboo-specs git commit -m "Initial commit of Bamboo Specs" git push
Step 3: Create a new Project in Bamboo
- Open Bamboo and go to Create > Create Project.
- Fill in Project name, e.g. Mars.
- If not auto-generated, fill in the Project Key – eg: MARS – this will be referenced in the YAML file.
- Click Save.
Step 4: Enable processing of Bamboo Specs in your repository
By default Bamboo will not look for Bamboo Specs in the Git repository until your explicitly tell it to do so. Let's do it now:
- Go to .
Select your project Mars.
- Select Link new repository
- Select a Bitbucket Server / Stash repository type.
- Choose a name for your repository.
- From the Server drop-down, select your Bitbucket Server.
- Select the
Bamboo / tutorialrepository from the Repository drop-down. - Click Confirm.
Your new repository is created and you can start using it in Bamboo. Bamboo will checkout your repository, process it and create plan.
Execution of Bamboo Specs will create or update configuration of plans accordingly.
In this tutorial we simply grant access to one project in the Bamboo instance. You can fine-tune project access, see Enabling repository-stored Bamboo Specs how to do this.
Step 5: Check if plan was created
- In Bamboo from the header, select Build > All build plans.
Open the project and plan you've just created.
All configuration options are disabled because entire plan configuration is now managed by Bamboo Specs from your Bitbucket repository.
Click Run plan to execute the build.
- Find the "Hello World!" message in the logs.
Regardless whether your Bamboo Specs were processed successfully or not, you'll receive an email with status of you your Bamboo Specs execution.
Next steps
Here are some resources that can help you with writing your own Bamboo YAML Specs: