Integration with GitLab Issues

This article describes how you can set up an integration with the GitLab issues system to be able to add issue links to your Allure TestOps test cases and launches. If you need to set up a GitLab CI integration to trigger test runs and receive test results, see this article instead.

If you have already set up a GitLab CI integration for your GitLab server, the only thing you need to do to be able to link GitLab issues is to add GitLab project IDs to your current integration (see Enabling integration for Allure TestOps project).

To set up GitLab Issues integration, you need to:

1. Generate an access token in your GitLab settings.
2. Add GitLab integration in the Allure TestOps administration panel.
3. Enable the integration in Allure TestOps project settings using the generated access token.

Generating GitLab access token

1. In GitLab, click on your avatar and select Preferences.

2. In the menu on the left, click Access Tokens.

3. Click Add new token on the right side of the page.

4. Fill in the fields:

   • Token name — a name to help you recognize the token (e.g., "Token for Allure TestOps").
   • Expiration date — any date within a year from the current date. After this date, the integration will stop working, and you will need to create a new token to continue using the integration.

5. Check the api and read_api boxes under Select scopes.

6. Click Create personal access token.

7. After the page reloads, click the copy icon under Your new personal access token. Save the token in a safe place, it will be needed later.

You can also use project access token instead of a personal access token, but in that case the integration will be limited to a single project.

Adding GitLab integration in Allure TestOps

1. Log in to Allure TestOps using an administrator account.

2. Go to Administration → Integrations.

3. Click + Add integration in the top right corner of the page.

4. In the resulting window, select GitLab.

5. Fill in the fields:

   • Name — a name to help you recognize this integration later.
   • Endpoint — the URL of your GitLab server (e.g., https://gitlab.example.com/).

6. If your GitLab server uses a self-signed SSL certificate, check the Disable certificate validation checkbox.

7. Click Add integration.

Enabling integration for Allure TestOps project

1. In Allure TestOps, open your project.

2. Go to Settings → Integrations.

3. Find the GitLab integration and click Add integration.

4. Under Settings, add the project IDs of the GitLab projects you want to use.

   To find the project ID, open the project in GitLab and go to Settings → General

5. Under Secret, enter the GitLab access token you previously generated.

6. Click Add integration.

Adding issue links

Once you have set up a GitLab Issues integration, you can add issue links to your test cases and launches.

To link a test case to a GitLab issue:

1. Go to Test cases.
2. Open the test case you want to link and click the pencil icon on the right side of the page, next to Issues links.
3. In the resulting window, click the + Add button.
4. Under Issue tracker, select your GitLab Issues integration.
5. Under Key, select the issue to which you want to link the test case.
6. Click Submit.

To link a launch to a GitLab issue:

1. Go to Launches.
2. Click ⋯ next to the launch you want to link to the issue and select Edit.
3. In the window that opens, click + Add in the Issues section.
4. Under Issue tracker, select your GitLab Issues integration.
5. Under Key, select the issue to which you want to link the launch.
6. Click Submit.