Xcode Server and Continuous Integration Guide: Manage and Monitor Bots from the Report Navigator

Manage and Monitor Bots from the Report Navigator

On your development Mac, the Xcode report navigator provides access to detailed information about your bots and the integrations they’ve performed on the server. By selecting a bot or integration in the report navigator, you can view its information in the editor area of the Xcode workspace. You can also edit, delete, and create bots from the report navigator, and initiate or cancel their integrations.

Manage Bots in the Xcode Report Navigator

In Xcode on your development Mac, you can choose View > Navigators > Show Report Navigator or click the Report Navigator button in the navigator bar (Figure 6-1) to display a list of your bots. You can click By Group to display status information gathered under each of the bots.

image: ../Art/xcode_report_navigator_sidebar_2x.png

You can Control-click a bot to display a shortcut menu (Figure 6-2) that allows you to:

Create a new bot
Edit a bot—You can change its scheme, name, schedule, actions, email recipients, and test devices.
Delete a bot—When you remove a bot, you stop its future integration actions and remove existing builds and archives.
Start a new integration of a bot immediately—Xcode displays live progress information as a bot integrates, right down to the source file being compiled by your bot.
Cancel an integration currently in progress

image: ../Art/xcode_report_navigator_bot_contextual_menu_2x.png

Monitor and Manage Bots in the Bot Viewer

You can view summaries of a bot’s integrations by selecting the bot in the Xcode report navigator.

To view a summary of integration results for a bot

At the top of the report navigator, click By Group.

Status information is gathered for each of the bots.
Select the bot whose integrations you want to view.

In the editor area of the workspace window, the bot viewer displays a summary of the integrations the bot has performed, along with any commits, build errors and warnings, static analysis issues, and test failures.

You can initiate some bot management operations in the editor area of the workspace window:

image: ../Art/xcode_bot_viewer_operations_2x.png

To start an integration, click Integrate Now.
To update a bot, click Edit Bot.

In the editor area, the Summary section of the bot viewer displays these elements:

Bot Details. The scheme, current integration status, average duration, number of commits, tests, average issues, and successes. You can configure the Bot Details area to display statistics for Today, This Week, or This Month.
Build History. A bar graph depicting the errors, warnings, and static analysis issues the bot encountered when building. Click a bar to display a tally of the issues.
Test History. The number of successful and failed test cases the bot has performed. Click a bar to display a tally of the passed and failed tests.

Review Integration Details in the Integration Viewer

You can view details about an integration by selecting it in the report navigator.

To view details about an integration

At the top of the report navigator, click By Group.

A list of integrations, if not already visible, is collapsed under each of the bots.
Select the bot whose integrations you want to view.
If the bot’s integrations aren’t already visible, click the disclosure triangle to the left of the bot to display its integrations.

To the right of each integration listed in the report navigator, Xcode displays an icon that indicates whether there was an error, a warning, a static analysis issue, or an integration failure. At a glance, this allows you to quickly assess the status of your bot’s integrations.
Select a specific integration.
In the editor area of the workspace window, the integration viewer displays information, including:
- A summary of the integration’s results
- The number of errors, warnings, static analysis issues, and test-case failures encountered
- If applicable, lists of new issues, resolved issues, and build service issues
- If applicable, a build Results area, allowing you to download an archive of the product
- A Device Testing Summary, which lists any devices tested and their pass or fail status
In the editor area of the workspace window, click Tests to view a list of tests and their pass or fail status for the integration.

If you have multiple test devices, click the disclosure triangle to the left of a test to view the pass or fail status for each individual device.

If your project is configured to conduct performance testing, you can view performance test results and specify a baseline. Specifying a baseline for a performance test adds value to the test and causes the integration to fail if the test falls outside of a certain threshold below the baseline.
In the editor area of the workspace window, click Commits to view details about the new commits included in the integration. Commits may be viewed for all committers, or you may select an individual committer.

By clicking the “Show modified files” button, you can view the files that are part of the commit in the Xcode comparison view, allowing you to identify the specific code changes that were made.
In the editor area of the workspace window, click Logs to view the logs of the actions that occurred during the integration. Use filters to display all log messages, issues, or errors, and use the search field to find specific messages.

If a bot is actively performing the selected integration, the editor displays its live progress instead of results for the integration, as shown in Figure 6-3. Results are displayed after the integration has finished.

image: ../Art/xcode_report_navigator_integration_progress_2x.png

Xcode Server Environment Variable Reference

Monitor Bots from a Web Browser