HipChat

HipChat is a chat service designed for groups, providing video chat and screen sharing. Buddybuild offers a first-class integration with HipChat, providing notifications for build status, feedback submissions, and crash reports directly to the rooms that you use.

There are a number of sub-sections on this page:

This section describes how to navigate to the HipChat integration settings, and is referred to by several procedures described on this page.

  1. Log in to the buddybuild dashboard.

  2. The App Settings button Click the App Settings button in the top toolbar. The Default build configuration screen is displayed:

    The Default build configuration screen

  3. The Integrations button In the left navigation bar, click the Integrations button. The first of the Integrations screens (Apple Dev Connection) is displayed:

    The Apple Dev Connection screen

  4. The HipChat button In the left navigation, click the HipChat button. The HipChat screen is displayed:

    The HipChat screen

    If you have previously configured HipChat, you might instead see:

    The HipChat screen with existing configuration

Connect your HipChat room

These steps describe how to establish a connection between buddybuild and a specific HipChat room. You can create as many HipChat room connections as required.

  1. In a separate browser window or tab, log in to HipChat.

    The HipChat login screen

  2. Navigate to the room you would like to connect with buddybuild.

    A HipChat room

  3. The HipChat Integrations button In the bottom right corner, click the Integrations button.

  4. At this point, how you proceed depends on whether you already have integrations or not. Proceed with one of the following:

    1. If you do not have any configured integrations, the following dialog appears:

      The HipChat Integrations dialog

      The Check out HipChat integrations button Click the Check out HipChat integrations button.

    2. If you do have configured integrations, the following dialog appears:

      The HipChat Integrations dialog, with configured integrations

      The Install new integrations button Click the Install new integrations button.

    In either case, the Integrations showcase screen is displayed:

    The Integrations showcase screen

  5. The Build your own integration button Click the Build your own integration button. The Build your own screen is displayed;

    The Build your own screen

  6. Enter a name for the integration in the Name your integration field. We recommend calling this integration buddybuild.

  7. The Create button Click the Create button. The Integration configuration screen is displayed:

    The Integration configuration screen

  8. Copy the contents of the Send messages to this room by posting to this URL field.

  9. In your original browser window or tab, Navigate to the HipChat integration settings.

  10. Depending on whether you have an existing connection or not, perform one of the following:

    1. The Add a HipChat room button If you do not already have a HipChat connection configured, click the Add a HipChat room button.

    2. The Connected rooms tab If you do have an existing HipChat connection, click the Connected rooms tab. The Connected rooms screen is displayed:

      The Connected rooms screen

      The Add new button Click the Add new button.

    For both options, the Add a HipChat room screen is displayed:

    The Add a HipChat room screen

  11. Enter a name for the room connection in the Room name field.

  12. Paste the URL that you copied from the HipChat Integration configuration screen into the Webhook URL field.

  13. The Add room button Click the Add room button. The Connection confirmation screen is displayed:

    The Connection confirmation screen

  14. Here, you have a choice:

    1. The Yes, share with all apps button If you do wish to share this room connection with all apps, click the Yes, share with all apps button.

    2. The No thanks! button If you do not wish to share this room connection with all apps, click the No thanks! button. The room connection is associated only with the current application.

    For both options, the HipChat screen is displayed:

    The HipChat screen, with no notifications yet configured

Configure branches

This section describes how to configure buddybuild’s HipChat integration for branches, including for All branches, specific branches, or patterns that can match branches and/or tags.

All branches

You can configure notifications for all branches.

  1. Navigate to the HipChat integration settings

  2. The Add new button You can configure buddybuild notifications for all branches of your application, or you can configure notifications for a specific branch. Click the appropriate Add new button. The HipChat screen is displayed, which now includes the All branches notifications configuration panel:

    The All branches notifications configuration panel

  3. Continue with Room selection.

Branch specification

You can configure notifications for a specific branch, or a pattern that can match branches and/or tags.

  1. Navigate to the HipChat integration settings

  2. The Add new button Click the Add new button beside the Notifications for specific branches subheading.

    You can Choose a specific branch which configures notifications for one branch, or Define a pattern to match which configures notifications for any matching branches or tags.

Choose a specific branch

  1. Click the Choose a specific branch tab. The Specific Branch selection screen is displayed:

    The Specific Branch selection screen

  2. If you have many branches, click the branch filter field and enter the name of the desired branch (or portion thereof); the list of branches displays only matching branches.

  3. The Branch add button Move your pointer over the branch you want to choose. An Add button appears at the right of the row. Click the Add button. The HipChat screen is displayed, which now includes a branch-specific notifications configuration panel:

    A branch-specific notification configuration panel

  4. Continue with Room selection.

Define a pattern to match

  1. Click the Define a pattern to match tab. The Branch pattern selection screen is displayed:

    The Branch pattern selection screen

  2. Click the branch filter field and enter the pattern that the desired branches should match; the list of branches displays only matching branches.

  3. By default, the pattern applies to both tags and branches. You can choose to apply the pattern to Tags only, or to Branches only. Click the appropriate checkbox. The list of branches updates accordingly.

  4. The Create button Click the Create button. The HipChat screen is displayed, which now includes a pattern-specific notifications configuration panel:

    A pattern-specific notifications configuration panel

  5. Continue with Room selection.

Room selection

This section describes how to select the HipChat room to which buddybuild should send notifications.

  1. The Room selection dropdown In the appropriate notifications configuration panel, click the Room selection dropdown. The Room selection menu is displayed.

  2. The Room selection menu Select the channel to which buddybuild should send notifications. The Notifications configuration tabs become enabled:

    The Build tab

Configure notifications

This section describes the available kinds of notifications and their options.

Build notifications

The Build tab

On the Build tab, the following notification configuration options are available:

  • The Build success menu Build success: You can choose to receive buddybuild notifications for:

    • All successful builds: whenever your application builds successfully.

    • Only when the build gets fixed: for the first successful build after one or more build failures.

    • None: no notifications for build success are sent.

  • The Build failures menu Build failures: You can choose to receive buddybuild notifications for:

    • All build failures: whenever your application fails to build successfully.

    • Only when the build breaks: for the first failed build after one or more successful builds.

    • None: no notifications for build failures are sent.

  • Xcode updates: Click the toggle button to enable/disable notifications whenever buddybuild makes a new version of Xcode available.

    Note
    This option is only available for All branches. It is not available for specific-branch or pattern-specific configuration.

Deployment notifications

The Deployment tab

Note
Deployment notifications are only available for All branches. They are not available for specific-branch or pattern-specific configuration.

Click the associated toggle button to adjust these notification configuration options:

  • User failed to install a build: when enabled, receive a notification whenever a test user fails to install a build.

  • Device added to Apple account: when enabled, receive a notification whenever a new device is associated with your iTunes Connect account.

  • Failed upload to App Store: when enabled, receive a notification when buddybuild’s attempt to upload a build to iTunes Connect fails for any reason.

  • Tester unsubscribed from a deployment group: when enabled, receive a notification when one of your test users elects to stop receiving announcements of new builds.

Feedback notifications

The Feedback tab

  • User Feedback: Click the toggle button to enable/disable notifications whenever a test users sends feedback about your application.

  • The Crash reports menu Crash reports: You can choose to receive buddybuild notifications for:

    • All crash reports: whenever your application crashes on a test user’s device.

    • New crash report types: for new types of crashes that have not previously been reported.

    • None: no notifications for application crashes are sent.

Edit notification configuration

Individual notification settings can be adjusted at any time. Adjustments take effect immediately for all future notifications.

All branches

You can only adjust individual settings in the all branches panel, or by deleting notification configuration; there are no other editing options.

Branch-specific notifications

Once branch-specific notifications settings are established, it is not possible to adjust which branch they apply to. If you need to accomplish this, create branch-specific settings for the "new" branch and then delete the original branch-specific settings. See Branch specification and Delete notification configuration for details.

Pattern-specific notifications

The pencil button You can adjust the pattern for pattern-specific notification settings, by clicking the Pencil icon at the top right of the appropriate panel. The Edit branch pattern screen is displayed:

The Edit branch pattern screen

The Save button Adjust the pattern as necessary (see Define a pattern to match for more details), then click the Save button.

Delete notification configuration

The Trashcan icon When you need to delete notification configuration settings, for all branches, specific branches, or pattern-specific branches or tags, click the Trashcan icon at the top right of the appropriate panel. The panel is removed, and notifications based on the deleted configuration cease immediately.

Delete room connection

The steps to delete a room connection differ between connections that are available for all apps and connections available for select apps.

  1. The all-apps indicator For connections available for all apps

    1. Log in to the buddybuild dashboard.

    2. Select Manage Org in the avatar dropdown Move your mouse pointer over your avatar in the top right corner. A dropdown menu appears.

    3. Select Manage Org. The Manage Organization screen appears:

      The Manage Organization screen

    4. The Integrations button In the left navigation, click the Integrations link. The first of the Integrations screens (Apple Dev Connection) is displayed:

      The Apple Dev Connection screen

    5. The HipChat button In the left navigation, click the HipChat button. The HipChat screen is displayed, showing all of the shared HipChat rooms:

      The HipChat screen

    6. The Trashcan icon Click the Trashcan icon beside the room connection you wish to delete. A delete confirmation dialog appears:

      The HipChat connection delete confirmation dialog

    7. The Delete HipChat room button Click the Delete HipChat room button to complete the deletion of the connection.

      The Cancel button If you want to continue using the HipChat room connection, click the Cancel button.

  2. For other connections, not available to all apps

    1. Navigate to the HipChat integration settings

    2. Click the Connected rooms tab. The connected room are displayed:

      The list of connected rooms

    3. The Trashcan icon Click the Trashcan icon beside the room connection you wish to delete. A delete confirmation appears:

      The Connection delete confirmation panel

    4. The Delete button Click the Delete button to complete the deletion of the connection.

results matching ""

    No results matching ""