GitHub app for test sessions

2 minute read

The GitHub app for test sessions gives developers convenient, timely access to test results from their GitHub pull requests. Developers can start investigating failures immediately, without waiting for the entire CI process to finish. Test results are delivered as comments on pull requests.

Access to associated workflows and test files via links provided in the CloudBees Smart Tests web app is also available.

Installation and features

The following steps are required to enable the GitHub app for test sessions:

  1. Navigate to the GitHub app under Actions  Notifications in the CloudBees Smart Tests web app.

  2. Select Install GitHub app to begin the installation.

    1. Your GitHub org admin might have to approve that process.

    2. Complete the authorization in GitHub to allow the app to access your repositories.

    3. After authorization is complete, you are redirected back to the CloudBees Smart Tests web app.

  3. Verify that your test session is associated with a GitHub pull request.

    1. Use the CloudBees Smart Tests web app to find a test session associated with a GitHub pull request.

Comments on associated pull requests begin to appear.

GitHub app for test sessions comment on pull request
Figure 1. GitHub app for test sessions comment on pull request

The GitHub app for test sessions includes the following features:

  • View workflow run takes you to the workflow in GitHub Actions where this test session was triggered.

  • View pull request takes you directly to the pull request page for this session.

Additionally, once the GitHub app is integrated, you can jump directly to failing tests associated with files stored in GitHub repositories.

Accessing failing tests in GitHub

To access failing tests, follow these steps:

  1. Navigate to a test session page with a failure.

  2. Navigate to the Failed tests column at the bottom of the page.

  3. Select the ellipses for the desired failed test.

  4. Select the Open in GitHub link to open this test file directly in GitHub.