Skip to main content

Creating GitLab Issues

QA Sphere allows you to integrate with GitLab using the Custom Issue Tracker feature. This integration enables you to create GitLab issues directly while going through test cases in a test run, streamlining your workflow and ensuring efficient issue tracking within your GitLab projects.

Configuring GitLab as a Custom Issue Tracker​

To integrate GitLab Issues into QA Sphere, follow these steps:

  1. Go to Settings by clicking the gear icon Settings wheel in the top right corner.

  2. Select Issue Trackers from the left sidebar.

  3. A list of all available projects will be displayed. Click the + button next to the appropriate project to add integration.

  4. Choose Custom Issue Tracker from the list of available integrations.

  5. You'll be presented with a form to configure your Custom Issue Tracker. Fill it out as follows:

    • Issue Tracker Name: Enter "GitLab" or a name of your choice.
    • New Issue Link: Enter the URL for creating a new issue in your GitLab project. For example: 
      https://gitlab.com/your-group/your-project/-/issues/new
    • Title Extraction Rule: Enter the rule that matches your GitLab issue URL structure. For example: 
      https://gitlab.com/your-group/your-project/-/issues/$(id:num)

  6. Click Save to add the GitLab integration.

Understanding Title Extraction Rule​

The Title Extraction Rule helps QA Sphere pre-fill the Issue Title based on the URL. For GitLab, you typically want to use $(id:num) as GitLab uses numeric IDs for issues. The rule you enter should match the structure of your GitLab issue URLs.

Using GitLab Issues Integration​

To create a GitLab issue during testing:

  1. Within your project, navigate to the Test Runs section.
  2. Select an existing test run or create a new one.
  3. Choose a test case within the run.
  4. When changing the status of the test case, click + Add Custom Issue (or the name you gave your custom tracker).

A new browser tab will open with the GitLab new issue page. The issue title will be pre-filled based on your extraction rule.

Complete the issue details in GitLab and submit the issue. Once created, you can copy the issue URL and paste it back into QA Sphere to link the issue to your test case.

All issues created for the test case will be saved under the Action History for this test run, providing a clear trail of documentation.

Benefits of GitLab Integration​

  • Flexibility: Customize the integration to match your specific GitLab project structure.
  • Seamless Workflow: Quickly access GitLab's issue creation page from within QA Sphere.
  • Consistency: Ensure all issues are properly documented and tracked in your GitLab project.
  • Traceability: Easily link test cases to specific GitLab issues for better tracking.
  • Efficiency: Reduce time spent switching between QA Sphere and GitLab.

By leveraging this custom integration, your team can maintain a cohesive and efficient testing and issue management process across QA Sphere and GitLab, tailored to your specific project needs.

Troubleshooting​

If you encounter any issues with the integration:

  1. Double-check that your New Issue Link is correct and accessible.
  2. Ensure your Title Extraction Rule correctly matches your GitLab issue URL structure.
  3. Verify that you have the necessary permissions in your GitLab project to create issues.

For further assistance, contact your QA Sphere administrator or support team at [email protected].