Skip to content
The docs are now organized by product area. Old links still work. Report a broken link

GitHub Integration

Connect Qualflare to GitHub to file GitHub issues automatically for new defects, failed test runs, failure clusters and flaky tests.

Last updated

The GitHub integration files GitHub issues from Qualflare. When an event you selected happens in a project, such as a new defect, Qualflare creates an issue in the repository you chose. It works one way: nothing you do in GitHub changes Qualflare.

Prerequisites

  • GitHub: organization admin (or repository owner, for personal accounts) permissions — installing a GitHub App requires this level of access on GitHub's side, regardless of the app.
  • Qualflare: a workspace role of Editor or higher to install the app, and the Editor role or higher on the project to connect a repository.

Setup

Step 1: Install the GitHub App

  1. In the workspace sidebar, open Integrations
  2. Find GitHub under CI/CD
  3. Click Install
  4. You are redirected to GitHub to install the Qualflare app
  5. Select the GitHub organization or account and the repositories to share, then click Install. Qualflare can file issues only in the repositories you share here
  6. You are redirected back to Qualflare with the integration installed

Step 2: Connect a Repository to a Project

  1. In the project sidebar, open Integrations
  2. Click Configure on the GitHub integration
  3. Select the Repository. Optionally add Labels and Assignees (comma-separated GitHub usernames)
  4. Under Events, select the events that should create an issue
  5. Click Save

What the Issue Contains

For a defect, the issue title is [Defect #12] <defect name>. The body lists the defect's severity, environment, category, status, team and root causes when they are set, then the description and the expected and actual results. It ends with Created automatically by Qualflare. Your Labels and Assignees are applied.

The issue has no link back to Qualflare. Instead, the defect shows the new issue under Linked issues.

Events

Qualflare EventGitHub Issue Title
Defect Created[Defect #12] <defect name>
Launch Failed[Launch #48] Failed — <status>
Cluster Created[Cluster] <cluster name>
Flaky Test Detected[Flaky] <test case name>

Launch Failed fires when results uploaded with the CLI, a reporter or the API include a failed, error, timed-out or aborted test. Qualflare only creates issues. It does not close, reopen, update or comment on them.

Disconnecting

Removing GitHub deletes every project's GitHub settings. To use GitHub again, install it and set up each project from scratch.

To remove the GitHub integration, open Integrations in the workspace sidebar, click the trash icon on the GitHub card, then click Remove. This removes the connection for all projects. It does not uninstall the Qualflare app from GitHub: do that in your GitHub organization or account settings.

See Also