⚠️ Warning: If you are using GitHub Enterprise, the configuration process (especially the Base URL) may differ. Please consult your administrator.
1. How does SQAI Suite Leverage This Integration?
Connecting to GitHub 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 Pull Request (PR).
2. Information Required from Your GitHub Account
To establish a secure, plug-and-play connection, we require three specific pieces of information, all of which can be quickly extracted from a repository URL, plus a secure Personal Access Token (PAT).
https://github.com/MY_ORGANIZATION/MY_REPO_NAME
Required Detail | How to Find It in the URL | Example Value |
Organization | The first segment after |
|
Repo Name | The name of the specific repository. |
|
Personal Access Token | Must be generated securely (See Section 3) |
|
Optional Base URL
The Base URL is optional and should only be filled in if you have a deviating URL from the default GitHub API (https://api.github.com/), which is typical with enterprise editions.
3. Setting up the Integration (Personal Access Token)
The most crucial step is generating a dedicated, fine-grained 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 pull requests.
Step 1: Navigate to Developer Settings
Click your Profile Icon in the top right corner of GitHub. 2. In the menu, click Settings.
On the Settings page (often in the left sidebar), scroll down and click Developer settings.
Step 2: Create Fine-Grained Personal Access Token
Under Developer settings, select Personal access tokens.
Select Fine-grained tokens (recommended over "Tokens (classic)" for security).
Click Generate new token.
Step 3: Set Access Token Scopes (Permissions)
When creating the token, you must grant the token access to the specific organization and set the necessary repository permissions:
Access: Select "Only select repositories" and specify the target repository
Permissions: Under Repository permissions, grant the following access levels:
Category | Required Access Level | Purpose |
Contents | Read and write | Essential for reading existing code for context and writing new files/commits. |
Pull requests | Read and write | Required for creating the Pull Request (PR) for your team to review. |
Metadata | Read-only | Mandatory for basic repository information and tracing. |
Commit statuses | Read and write | Allows SQAI to update commit statuses if needed. |
Step 4: Secure Token
Immediately copy and secure the generated Personal Access Token (PAT). GitHub 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 GitHub configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
Personal Access Token
Experiation Date (Optional)
Organization
Repo Name
Base URL (Leave default unless using Enterprise Edition)
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 GitHub integration.
5. Troubleshooting GitHub 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 Read and write permissions for Contents or Pull requests. | Verify PAT Scopes: Go to Developer Settings > Personal Access Tokens and ensure the token includes the required access levels (Section 3). |
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 GitHub URL (names are case-sensitive). |
SQAI Connects, But Cannot Write/Push | C. Repository Selection: The PAT was set to "All repositories" but not specifically targeted to the MY_REPO_NAME. | Edit Token: Ensure the token is explicitly configured to include the specific repository you are integrating with. |
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. |