TestOps logo
Try TestOps

GitHub Issues

GitHub Issues is the work-management integration between GitHub and Allure TestOps. It covers:

  • linking test cases and launches to GitHub issues;
  • issue lookup inside TestOps using repository-aware search;
  • supported defect workflows that create or reuse GitHub issues;
  • issue-mapping support for automatic links created from test metadata.

This page covers GitHub as an issue tracker. If your goal is workflow upload or workflow execution, use GitHub Actions instead.

If you have already set up a GitHub CI integration for your GitHub instance, update the existing token instead of creating a new integration:

  1. Check which type of token you used.

    • Fine-grained token — create a new token with Repository permissions → Actions and Issues both set to Read and write, and Repository access scoped to the repositories that contain workflows and issues. Update the token in the existing TestOps integration.
    • Classic token — create a new token with the repo and workflow scopes. Update the token in the existing TestOps integration.

  2. In the existing project integration, add the repositories that contain the issues you want to use (see step 3).

Before you begin

  • The GitHub service URL and API URL.
  • Access to create a GitHub personal access token.
  • The list of repositories whose issues TestOps must see.
  • Permission to add or enable integrations in the target TestOps project.

1. Create a GitHub access token

GitHub supports both fine-grained and classic personal access tokens.

  1. In GitHub, click your avatar and go to Settings.
  2. Click Developer settings.
  3. Go to Personal access tokens → Fine-grained tokens.
  4. Click Generate new token.
  5. Fill in the fields:
    • Token name — a name to identify the token, for example Token for Allure TestOps.
    • Expiration — how long the token should be valid. After this date the integration will stop working.
  6. Under Repository access, click Only select repositories and select the repositories that contain the issues you want to use.
  7. Under Permissions → Repository permissions, set Issues to Read and write. If the same integration will also trigger workflows, set Actions to Read and write as well.
  8. Click Generate token and copy the generated token. Save it in a secure location.
  1. In GitHub, click your avatar and go to Settings.
  2. Click Developer settings.
  3. Go to Personal access tokens → Tokens (classic).
  4. Click Generate new token → Generate new token (classic).
  5. Fill in the fields:
    • Note — a name to identify the token, for example Token for Allure TestOps.
    • Expiration — how long the token should be valid.
  6. Under Select scopes, check repo. If the same integration will also trigger workflows, check workflow as well.
  7. Click Generate token and copy the generated token. Save it in a secure location.

2. Add the global GitHub integration

An instance administrator should:

  1. Open Administration → Integrations in TestOps.

  2. Click + Add integration.

  3. Select GitHub.

  4. Fill in the fields:

    • Name — a stable name for the GitHub service, for example GitHub production.
    • Endpoint — https://github.com for github.com, or the GitHub Enterprise Server URL.
    • Endpoint for API calls — https://api.github.com for github.com, or <your-ghes-url>/api/v3 for GitHub Enterprise Server.

  5. If the GitHub server uses a self-signed certificate, disable certificate validation.

  6. Click Add integration.

3. Enable GitHub Issues in the project

  1. In TestOps, open the target project.

  2. Go to Settings → Integrations.

  3. Under Available integrations, find the GitHub integration and click Add integration.

  4. Under Settings, add the repositories whose issues should be available in the project. For each repository, click + Add and enter:

    • Owner — the GitHub owner or organization.
    • Repository name — the repository name.

    For example, for github.com/torvalds/linux the owner is torvalds and the repository name is linux.

  5. Under Secret, paste the GitHub access token.

  6. Click Test connection and save the project integration.

If a repository is missing from this list, its issues will not appear in the TestOps issue picker.

If your tests already emit issue labels through an Allure adapter, configure an issue mapping so TestOps can turn those labels into real issue links automatically.

  1. Open the TestOps project.

  2. Go to Settings → Issues.

  3. Click + Create.

  4. Fill in the fields:

    • Key — the short identifier your tests use in metadata.
    • Issue tracker — the GitHub integration you enabled for the project.

  5. Save the issue mapping.

Once the integration is set up, you can link test cases and launches to GitHub issues manually.

To link a test case:

  1. Go to Test cases and open the test case.
  2. Click the pencil icon next to Issue links.
  3. Click + Add.
  4. Under Issue tracker, select your GitHub integration.
  5. Under Key, enter part of the issue name and select it from the list.
  6. Click Submit.

To link a launch:

  1. Go to Launches.
  2. Click ⋯ next to the launch and select Edit.
  3. In the Issues section, click + Add.
  4. Under Issue tracker, select your GitHub integration.
  5. Under Key, enter part of the issue name and select it from the list.
  6. Click Submit.

Verify the integration

  1. Open a test case in TestOps and add an issue link.
  2. Confirm that the issue picker can search the expected GitHub repositories.
  3. Open a launch and add or edit an issue link there as well.
  4. If your team uses defect export, create or link a defect to confirm that the GitHub issue workflow is available in that view too.

Troubleshooting

The issue picker does not show the repository you need

Check these points first:

  • the repository owner and name were added in the project integration settings;
  • the GitHub token has access to that repository;
  • the token includes Issues read/write permission for the repository.

The same GitHub integration works for Actions but not for issues

The CI token is too narrow for issue workflows. Expand the repository list and add Issues permission to the token, or use a separate project-level token for the issue-tracking job.

© Qameta Software Inc. All rights reserved.