Build notification use cases

Subscribe to configurations and get notified of new builds

How to set up QuickBuild so that users can register their accounts themselves and create their build subscriptions to get notified of new release of my product.

  1. Enable user self-registering feature by creating a user group named "register" and make this group having view permission for all configurations holding public release of your products. Self-registered users will have the same permission as the "register" group.

  2. At the "root" configuration, create subscription notifier of desired type (by default, there is only one subscription notifier of Email type). Optionally you can override these subscription notifier at child configurations to refine the notification format for particular configurations.

  3. Now the users are able to register the accounts themselves. Through the "My settings" link, they can choose to be notified of new builds satisfying the specified condition. Notification methods (like Email, MSN Messenger) are determined by the type of subscription notifier you've created in step 2.

The build subscription is not restricted for self-registered users. All users can subscribe to their accessible configurations.

Get notified of manually triggered build

When I manually triggers a build, I want to be notified through MSN messenger when that build is finished.

  1. Make sure the subscription notifier of type MSN messenger is created in root configuration.

  2. Trigger a configuration manually, when the build setting page appears, select item "Build finished" from dropdown menu of property "notify condition", and choose MSN messenger for property notify by.

  3. In this way, you'll be notified through MSN messenger after the build is finished.

Send build notification to dynamic list of users

I have a project with several modules. To simplify the build setup, I define the notify step at project level, and have all module configurations inherit and use this notify step. How should I configure the notify step so that It sends notification to the module owner and all users who have made checkins recently.

  1. At project configuration, define a variable with the name "notification_group.module_owner" and give it an empty value like below:

    notification_group.module_owner=
  2. Define the same variable at each module configuration, and specify user name of the module owner. For instance, if module1 is owned by tommy and jerry, and configuration name of module1 is "root.project1.module1", you'll need to define the variable at configuration "root.project1.module1" as:

    notification_group.module_owner=tommy,jerry
  3. Create the "Send notification" step at the project level, and choose item [module_owner] and <users who checked in recently> as notification receiver.

This use case uses the concept of notification groups which is described in detail here.

Get build notification through RSS

How to get notified of new successful build generated in configuration root.myproduct.release through my RSS reader.

  1. Make sure configuration root.myproduct.release can be publicly accessible by creating a user group with name "anonymous" and assign view permission for configuration root.myproduct.release.

  2. From QuickBuild web interface, switch to "FIND BUILDS" tab. For the search criterions, specify successful for the status property, and root.myproduct.release for configuration property.

  3. Click on the search button to find matching builds. A RSS link (the XML button) will be displayed at right top of the search results area. Just copy this link into your RSS reader and you'll start to receive notification for new successful builds of root.myproduct.release. Click here for more information about this RSS link.