This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Notifications in Bamboo are triggered by a range of events involving a Plan and its Jobs, including build completion, build outcomes and comments being posted against build results. You can configure whether notifications are sent for a particular event and who they are sent to. Users can choose whether to receive their notifications via email, IM, both or neither.

(info) You must have the 'Edit' permission for a Plan, to add or remove notifications for it.

Event

Description

Plans

 

'All Builds Completed'

Bamboo will send a notification whenever the Plan build finishes, regardless of the Plan build's result. This notification is recommended for any Plans whose latest build activity is critical for people to be informed about.
(tick) This is a good Plan-based notification to use if you are new to Bamboo. You can change it to a less obtrusive notification option as you become more confident with continuous integration and Bamboo's build processes.

'Failed Builds And First Successful'

Bamboo will send a notification whenever:
- a build of this Plan fails.
- the Plan is 'fixed' (that is, the Plan's latest build is successful and the previous Plan build failed).
(tick) This notification is generally suitable for the majority of Plans.

'Change of Build Status'

Bamboo will send a notification only when there has been a change in status of the Plan's build activity over consecutive Plan builds — for example, only whenever a Plan's latest build changes from successful to failed or vice versa (i.e. 'fixed').
(tick) This notification option is less obtrusive than the other Plan notifications mentioned above.

'After X Failed Builds'

This notification allows you to specify the 'Number Of Failures' (i.e. number of failed builds of this Plan), after which Bamboo will send a notification.
(tick) This notification option minimises the number of messages sent by Bamboo if the Plan's builds fail on a frequent basis. You can also use this event to escalate Plan build problems, for example, to notify a manager when a Plan build fails five times.

'Comment Added'

Bamboo will send a notification whenever a comment is posted against a Plan build result. The email notification will contain all comments against the Plan build, whereas IM notifications will only contain the comment that triggered this notification event.
(tick) This notification can help improve collaboration between team members. Be aware that you will not receive notifications for any comments which you post yourself.

Jobs

 

'All Jobs Completed'

Bamboo will send a notification whenever a Job build of the Plan finishes, regardless of the Job build's result. This notification is recommended if the latest build activity of all Jobs in this Plan are critical for people to be informed about.
(tick) This is a good Job-based notification to use if you are new to Bamboo. You can change it to a less obtrusive notification option as you become more confident with continuous integration and Bamboo's build processes.

'Failed Jobs And First Successful'

Bamboo will send a notification whenever:
- a build of this Job fails.
- the Job is 'fixed' (that is, the Job's latest build is successful and the previous Job build failed).

'Change of Job Status'

Bamboo will send a notification only when there has been a change in build activity status of the Jobs within this Plan over consecutive Plan builds — for example, only whenever the latest build of any Job in this Plan changes from successful to failed or vice versa (i.e. 'fixed').
(tick) This notification option is less obtrusive than the other Job notifications mentioned above.

'First Failed Job For Plan'

If multiple Jobs fail in a Plan, Bamboo will only send a notification for the first failing Job detected by the Bamboo system.
(tick) This is a less obtrusive notification option that informs about a failing Job (and hence, Plan) in the shortest possible time.

'Job Error'

Bamboo will send a notification whenever an error occurs in one of the Plan's Job build processes (i.e. the activities that Bamboo performs to run a Job build). This event is not related to failures of the actual build itself (see the 'Failed Jobs And First Successful' and 'Failed Builds And First Successful' events above). For example, a notification will be sent if Bamboo encounters an error when connecting to the repository, or detecting changes.

'Job Hung'

Bamboo will send a notification whenever it determines that one of the Plan's Job builds has hung, according to the hung Job build criteria (read more about configuring your hung Job build settings).
(tick) Use this notification to ensure that the relevant people are informed when a Job build becomes unresponsive.

'Job Queue Timeout'

Bamboo will send a notification whenever one of the Plan's Job builds has been waiting in the queue for longer than the build queue timeout criteria (read more about configuring your Job's Build Queue Timeout settings).
(tick) Use this notification to ensure that the relevant people are informed when a Job build is stuck in the build queue for too long.

'Job Queued Without Capable Agents'

Bamboo will send a notification whenever one of the Plan's Job builds is queued and there are no agents capable of building it.
(tick) Use this notification to ensure that people are notified when changes to agents adversely affect your Job's builds.

For each Plan or Job, you can specify different recipients for each type of event notification. Also be aware that these recipients do not require Bamboo user accounts.

Before you begin

You need to configure Bamboo's SMTP email and/or instant messaging capabilities before Bamboo can send notifications. If you have not configured either or both of these, a note will display on the page prompting you to set up the appropriate server(s):

  • To configure an email server for Bamboo, click the 'Add an Email Server' link in the note and enter the email server details in the window that displays. See Configuring Bamboo to send SMTP Email for more information.
  • To configure an instant messaging server for Bamboo, click the 'Add an Instant Messaging Server' link in the note and enter the instant messaging server details in the window that displays. See Configuring Bamboo to use Instant Messaging (IM) for more information.

To add notifications for a Plan and/or its Jobs,

  1. Click 'Home' to go to the Dashboard.
  2. Click the 'All Plans' tab.
  3. Locate the plan in the list and click the 'Edit' icon:
  4. The Plan's Configuration pages will be displayed. Click the 'Notifications' tab to display the Plan's current Notifications settings.
  5. The 'Notifications' that you currently have set up will be displayed (see screenshot below). Add a new notification in the 'Add Build Notification' section as follows:
    • Select the type of 'Event' you want to be notified about. Refer to the list of events (above) for details.
    • Specify the 'Recipient':
      • 'User' — Type the username of the appropriate Bamboo user; or click the following icon to select from a list of users:
      • 'Group' — Type the name of the appropriate Bamboo group(s).
      • 'Email Address' — This is useful if you need to send email notifications to a person who is not a Bamboo user. Type the appropriate email address. Please note, that if you specify the email address of an existing Bamboo user, the user will receive notifications, even if they have elected not to receive notifications in their user preferences.
      • 'IM Address' — This is useful if you need to send Instant Messenger (IM) notifications to a person who is not a Bamboo user. Type the appropriate IM address.
        (info) If you specify a broadcast address (eg. 'project-x@broadcast.chat.mycompany.com'), Bamboo will not know the context of related IM responses.
        (info) If you specify the IM address of an existing Bamboo user, the user will receive notifications, even if they have elected not to receive notifications in their user preferences.
      • 'Committers' — A committer is the Bamboo user(s) who committed code to a particular build (i.e. someone who committed code after the previous build was checked out by Bamboo).
      • 'Watchers' — A plan's watchers are the Bamboo users who have marked this plan as one of their favourites.
  6. Click the 'Add' button.
  7. Repeat steps 5 and 6 until you have added all the build notifications that you wish to enable for this plan.
  8. Click the 'Save' button to save your changes.


Screenshot: 'Plan Build Notifications'



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.