Manage and Monitor Bots from the Report Navigator

Xcode’s report navigator provides access to detailed information about your bots and the integrations they’ve performed. By selecting a bot or integration, 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 Report Navigator

In Xcode on your development Mac, choose View > Navigators > Show Report Navigator. Click By Group to see status information gathered under each of the bots.

../art/xcode_report_navigator_sidebar_2x.png

Control-click a bot to display a shortcut menu that allows you to:

../art/xcode_report_navigator_bot_contextual_menu_2x.png

You can also create a bot from the shortcut menu in the report navigator.

Monitor and Manage Bots in the Bot Viewer

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

To view a summary of integration results for a bot

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

    Status information is gathered for each of the bots.

  2. 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 it has performed, along with any commits, build errors and warnings, static analysis issues, and test failures.

    ../art/bot_viewer-summary_2x.png

You can perform these operations in the bot viewer:

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

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

  1. 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.

  2. Select the bot whose integrations you want to view.

  3. If the bot’s integrations aren’t already visible, click the disclosure triangle to the left of the bot to display its integrations.

    You can quickly check the status of an integration. 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.

  4. Select a specific integration.

    ../art/bot_viewer_integration_summary_2x.png

    In the editor area of the workspace window, the integration viewer displays a summary of the integration’s results.

    The number of errors, warnings, static analysis issues, and test-case failures for that integration are summarized.

    Lists of new issues, resolved issues, and build service issues are displayed, if applicable.

    If applicable, a Build Results area is displayed, allowing you to download an archive of the product.

    You’ll also see a Device Testing summary, which lists any devices tested and their pass or fail status.

  5. 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 device.

    ../art/bot_viewer_tests_2x.png

    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.

  6. 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 Xcode’s comparison view, allowing you to identify the specific code changes that were made.

    ../art/bot_viewer_commits_2x.png
  7. 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.

    ../art/bot_viewer_log_2x.png

If a bot is actively performing an integration, the editor displays its live progress instead of results for the integration. Results are displayed after the integration has finished.

../art/xcode_report_navigator_integration_progress_2x.png