Automatic GitHub issue creation

With the mabl GitHub integration, mabl automatically creates a GitHub issue whenever it generates a mabl insight. Insights are generated when mabl detects a change relative to the baseline, such as when a plan that was previously passing starts to fail, or when a test’s page load time becomes significantly higher than expected.

Use automatic GitHub issue creation to surface meaningful changes in your application’s behavior to your team.

Setup

To get started, follow the instructions outlined in the GitHub integration setup article.

When you reach the GitHub integration page in mabl, toggle on the following settings:

• “Create GitHub RepositoryDispatch events for mabl insights”
• “Create GitHub issues for mabl insights”

Use the toggles and dropdowns in the Filter insights section to filter the insights that are important to your team. See the setup guide for a complete list of insight filters.

Run tests

To generate GitHub issues from mabl insights, configure your CI/CD workflow to trigger a mabl deployment event and associate the deployment event with the GitHub code revision hash. mabl uses the commit hash to trace plan runs back to the source repository so issues can be filed against the correct repo.

Pass the commit hash when you create the deployment event:

• mabl CLI: include --revision {commit-sha} in your mabl deployments create command.
• Deployments API: include the revision field in the request body.
• run-mabl-tests GitHub Action: the Action passes github.sha automatically. No additional configuration is required.

Example using the mabl CLI:

mabl deployments create \
  --application-id {app-id} \
  --environment-id {env-id} \
  --revision {commit-sha}

When a deployment runs and mabl generates an insight that matches your filter criteria, the insight is automatically filed as a GitHub issue with the respective details.

Managing GitHub issue creation

See the GitHub integration setup article for full details on customizing this feature’s behavior.