⚠️ Warning: GitLab supports both Cloud and Self-Managed instances. If using a Self-Managed instance, you must correctly configure the Base URL (see Section 4).
1. How does SQAI Suite Leverage This Integration?
Connecting to GitLab allows SQAI to integrate directly into your development workflow, transforming testing requirements into executable automation code:
Context-Aware Scripting: SQAI reads your existing codebase, framework conventions, and folder structure within the repository to generate high-quality, maintainable automation scripts that match your team's standards.
Direct Code Delivery: Allows SQAI to push generated automation code (e.g., Playwright or Selenium scripts) directly to a specified branch in your repository, ready for review and execution.
Version Control & Traceability: Ensures all generated code is immediately part of your version control history via a Merge Request (MR).
2. Information Required from Your GitLab Account
To establish a secure, plug-and-play connection, we require three pieces of information, all of which can be quickly extracted from a repository URL, plus a secure Personal Access Token (PAT).
Required Detail | How to Find It in the URL | Example Value |
Organization | The Group or User that owns the repository. |
|
Repo Name | The name of the specific repository (project). |
|
Personal Access Token | Must be generated securely (See Section 3) |
|
3. Setting up the Integration (Personal Access Token)
The most crucial step is generating a dedicated Personal Access Token (PAT) with the correct scope for reading code context and pushing new scripts.
The user generating the PAT must have the necessary permissions to read code, write commits, and create Merge Requests.
Step 1: Navigate to Access Tokens
Click your Profile Icon in the top right corner of GitLab.
In the menu, click Preferences. 3. In the left sidebar under User Settings, select Access Tokens.
Step 2: Create Personal Access Token
Click Add new token. 2. Provide a name (e.g., "SQAI Integration") and set a desired Expiration date.
Step 3: Set Access Token Scopes (Permissions)
When creating the token, you must select the following scopes:
Scope | Required Access Level | Purpose |
| Read/write access | Grants complete read/write access to the API (required for creating Merge Requests). |
Step 4: Secure Token
Immediately copy and secure the generated Personal Access Token (PAT). GitLab will not display this token again.
4. Entering Details in SQAI Suite
Once you have secured your PAT and gathered your Organization and Repo details, you can complete the setup in the SQAI Suite platform.
Step 1: Navigate to Integrations Go to your SQAI Suite settings and select the Integrations page. Find and select the GitLab configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
Personal Access Token
Organization
Repo Name
Base URL (Only required for Self-Managed/Enterprise editions)
Step 3: Save and Confirm Click "Save Configuration." If the set-up is successful, you will receive a success message and see a green indicator next to your GitLab integration.
5. Troubleshooting GitLab Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to repository access.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Access Denied" | A. Incorrect PAT Scope: The PAT is missing required scopes, especially the | Verify PAT Scopes: Go to User Settings > Access Tokens and ensure the token includes the |
Invalid Resource: Cannot Find Repo | B. Incorrect Name/Typo: The Organization or Repository Name entered contains a typo. | Double-Check URL: Verify the names are entered exactly as they appear in the GitLab URL (names are case-sensitive). |
Self-Managed Instance Connection Fails | C. Incorrect Base URL: The optional Base URL field is either empty or incorrect for a self-managed instance. | Verify Base URL: Ensure the Base URL is set to your specific GitLab instance domain (e.g., |
Token Expired | D. Token Expiration: PATs are set to expire after a certain period. | Generate New PAT: The original user must create a new PAT with the required scopes and update the configuration in SQAI Suite. |