Setting up plan build dependencies
You may want to trigger a plan build when another plan's build has successfully completed. This ensures that changes to any job's source code associated with one plan does not break the build of another dependent plan (known in this context as a child plan).
For example, there could be two plans in Bamboo:
- Acme – Core — which contains the core code for an application.
- Acme – Plugin — which contains code for a plugin to the application.
In this scenario, the Acme – Plugin plan is a child of Acme – Core. Any changes to source code associated with the Acme – Core plan should trigger a build of Acme – Plugin.
On this page:
Triggering dependent plans
To trigger a child plan to build when this plan builds successfully:
- From the top navigation bar select Builds > All build plans.
- Locate the plan in the list and select the edit (
) icon to display the plan's Configuration pages. - Select the Dependencies tab.
- Under Child plans, begin typing a plan name in Search for plan to select child plans to trigger. You can set multiple plans to be triggered.
- Select Save.
Automatic dependency management with Maven 3
Automatic Dependency Management only works with the master plan.
Automatic Dependency Management is a feature for users who use Maven 3 and wish for their parent and child dependencies to be set up according to the dependencies in the Maven pom.xml. Every time the plan is run, the Bamboo Automatic Dependencies are updated to reflect any additions or removals of Maven dependencies.
Bamboo Maven auto dependency always lists the dependencies needed and produced by a plan. However, linking the parent-child plans will happen for SNAPSHOT builds only. Effectively, Bamboo searches for the word SNAPSHOT in the pom.xml file.
To setup automatic dependency management:
- From the top navigation bar select Builds > All build plans.
- Locate the plan in the list and select the edit () icon to display the plan's configuration pages.
- Locate the job that contains the pom.xml you wish to use to automatically update plan dependencies by analyzing a Maven pom file.
- Select Actions > Configure job.
- Select the Tasks tab.
Select Add task and add the Maven Dependency Processor task to the job. For best results, ensure that the task runs last by dragging it to the bottom of the task list. For more information on configuring tasks, see Configuring tasks.
Override project file
Optional. The location relative to the working directory or sub-working directory where the project file (pom.xml) is located.
Working subdirectory
Optional. The subdirectory from which the Task should look for the project file (pom.xml).
Alternate location of settings.xml
Optional. Specify an alternate settings.xml to be used if the Task needs to resolve dependencies from specific Maven repositories.
Path to Maven local repository
Optional. Specify a full path to a local Maven repository for the Task to use to resolve dependencies.- Select Save.
- Use the Plan Navigator to return to the plan.
- Select the Dependencies tab.
- Select Automatic Dependency Management. You should see the name of the job for which you configured the Maven Dependency Processor appear.
- Select Save.
Dependency blocking
Dependency blocking is an advanced feature of dependent build triggering that can be used to manage plan builds with parent build dependencies. This ensures that a "tree" of dependent builds always runs in tree hierarchy order, even if child plan builds are triggered independently of their parents. For more information, see Dependency blocking strategies. Please note, dependency blocking only works when the plan build is triggered because of source repository code updates.
Notes
Build dependencies work together with the trigger configuration of plans to trigger builds of these plans. For example, you can set up Plan A to poll its repository for changes as well as to be dependent on a parent plan (Plan B). In this case, builds of Plan A will be triggered when code changes are detected in its repository and also when builds of Plan B complete successfully.
If you want your builds to only be triggered by successful parent builds from your build dependencies, don't configure triggering for your child plans at all. See Running a plan build manually.
- If the child build uses the same source as the parent build (for example, the Subversion URL is the same), the child build will be forced to check out the same revision of source code as the parent build. This ensures that builds are consistent when triggering one build from another.
- Take care not to create circular dependencies, where your child build triggers one of its parent builds. Otherwise your plans may build continuously. See Running a plan build manually.