You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/kaneai-github-app.md
+37-18Lines changed: 37 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,8 +40,6 @@ slug: github-app-integration/
40
40
></script>
41
41
42
42
# LambdaTest AI Cloud GitHub App Integration
43
-
***
44
-
The **LambdaTest AI Cloud GitHub App** is an enterprise-grade integration that brings intelligent, AI-powered test automation directly into your GitHub development workflow. By seamlessly analyzing pull request changes, the app automatically generates comprehensive test cases, executes them across your testing infrastructure, and provides actionable insights-all within your GitHub interface.
45
43
46
44
## 1. Overview
47
45
@@ -85,9 +83,8 @@ Before implementing the LambdaTest AI Cloud GitHub App in your development workf
85
83
### Repository Requirements
86
84
87
85
-**GitHub Repository Access**: Administrative access to the GitHub repositories where you want to install the app
88
-
-**Repository README**: A well-documented README.md file in your repository (the AI uses this for contextual understanding of your application)
86
+
<!-- - **Repository README**: A well-documented README.md file in your repository (the AI uses this for contextual understanding of your application)-->
89
87
90
-
> **Note:** KaneAI access is required to utilize the AI-powered test generation capabilities of this GitHub App. Without it, the app cannot analyze code changes or generate test cases.
91
88
92
89
---
93
90
@@ -109,7 +106,12 @@ During installation, you'll need to specify which repositories should have acces
109
106
-**Organization-wide Installation**: Select **All repositories** to enable the app across your entire GitHub organization
110
107
-**Selective Installation**: Choose **Only select repositories** and specify individual repositories for more granular control
111
108
112
-
After making your selection, complete the installation and authorize LambdaTest to access the selected repositories.
After making your selection and clicking the **Install and Authorize** button, you will be redirected to LambdaTest's integration page where under the **My Integrations** section you will be able to see this application.
For pilot programs or initial rollouts, we recommend installing on a select subset of repositories first. Once your team is comfortable with the workflow, you can expand access organization-wide.
@@ -120,12 +122,31 @@ For pilot programs or initial rollouts, we recommend installing on a select subs
120
122
Confirm the installation was successful by:
121
123
122
124
1. Navigating to your GitHub organization's **Settings** page
123
-
2. Selecting **Installed GitHub Apps** from the left sidebar
124
-
3. Verifying that **LambdaTest AI Cloud** appears in the list of installed applications
125
+
2. In left side menu under **Integrations**, click **Applications**.
126
+
3. Selecting **Installed GitHub Apps** from the left sidebar
127
+
4. Verifying that **LambdaTest AI Cloud** appears in the list of installed applications
125
128
126
129
You can also click on the app to review and modify repository access permissions at any time.
Uninstalling the GitHub App will stop all AI-powered test generation workflows on your pull requests. This action cannot be undone, and you'll need to reinstall the app to restore functionality.
| `project_id` | The unique identifier for your LambdaTest Test Manager project | Navigate to your project in Test Manager and copy the ID from the URL |
154
175
| `folder_id` | The folder where generated test cases will be organized | Create or select a folder in Test Manager and obtain its ID from the URL |
155
-
| `assignee` | The LambdaTest user ID who will be assigned to test runs | Found in your LambdaTest account profile settings |
176
+
| `assignee` | The LambdaTest user ID who will be assigned to test runs for executions | Can be referenced from APIs |
156
177
| `environment_id` | The target testing environment (browser, OS, device configurations) | Create environments in Test Manager and reference their IDs |
157
178
| `test_url` | The base URL of your application under test | Your staging or testing environment URL where tests will be executed |
158
179
@@ -174,8 +195,9 @@ Your final repository structure should look like this:
174
195
your-repo/
175
196
├── .lambdatest/
176
197
│ └── config.yaml # LambdaTest configuration
177
-
├── src/ # Your application source code
178
-
├── README.md # Detailed project documentation (used by AI)
198
+
└── agent.md # Optional file for custom instructions to enhance responses
199
+
├── src/ # Your application source code
200
+
├── README.md # Detailed project documentation (used by AI)
179
201
└── ... other project files
180
202
```
181
203
@@ -202,9 +224,7 @@ The test generation workflow is triggered through a simple comment on any pull r
202
224
```bash
203
225
@LambdaTest Validate this PR
204
226
#OR
205
-
@LambdaTest Generate test cases
206
-
#OR
207
-
@KaneAI Generate test cases
227
+
@KaneAI Validate this PR
208
228
```
209
229
210
230
Any of these commands will initiate the complete AI-powered testing workflow, from analysis to execution and reporting.
@@ -216,7 +236,7 @@ Any of these commands will initiate the complete AI-powered testing workflow, fr
216
236
After you post the trigger comment, KaneAI immediately begins working:
217
237
218
238
1. **Code Analysis**: The AI examines all code changes in the pull request, including file modifications, additions, and deletions
219
-
2. **Context Gathering**: Your repository's README, existing test patterns, and project structure are analyzed to understand application context
239
+
2. **Context Gathering**: Your repository's README.md, PR Title, Description, Comments and AGENT.md are analyzed to understand application context
220
240
3. **Test Strategy**: Based on the changes and context, the AI determines which areas require testing and what scenarios to cover
221
241
4. **Test Generation**: Intelligent test cases are created with appropriate assertions, validations, and edge case handling
222
242
@@ -235,6 +255,7 @@ As soon as the workflow begins, KaneAI posts a comprehensive progress tracker co
235
255
236
256
- **Current Workflow Status**: Real-time updates on which phase is currently executing
237
257
- **Test Case Pipeline**: Progress through analysis, generation, authoring, and code generation phases
258
+
- **Intelligent Test Case Suggestion**: AI suggests semantically similar test cases present in the project
238
259
- **Test Run Management**: Execution status, including configuration, triggering, monitoring, and completion
239
260
- **Reporting Status**: Final report generation and PR approval recommendation
240
261
@@ -264,7 +285,6 @@ This comment updates dynamically as test authoring progresses, so you can monito
264
285
To prevent test redundancy and optimize your test suite, KaneAI performs semantic analysis against your existing test inventory:
265
286
266
287
- **Similar Test Identification**: Finds existing tests that cover similar functionality or user scenarios
267
-
- **Reusability Recommendations**: Suggests whether to reuse, extend, or replace existing tests
268
288
- **Test Suite Optimization**: Helps maintain a lean, efficient test suite by preventing duplicate coverage
269
289
270
290
This intelligent analysis ensures your test repository remains organized and maintainable as it grows over time.
@@ -278,7 +298,6 @@ When test execution begins on HyperExecute, a dedicated comment provides:
278
298
- **Test Run Configuration**: Details about the execution environment, browser matrix, and parallel execution settings
279
299
- **Real-Time Execution Status**: Live updates as tests run, including pass/fail counts and completion percentage
280
300
- **HyperExecute Dashboard Link**: Direct access to detailed logs, screenshots, video recordings, and network traces
281
-
- **Execution Duration**: Time tracking to help optimize CI/CD pipeline performance
282
301
283
302
<img loading="lazy" src={require('../assets/images/kaneai-github-app/5-test-run-created.png').default} alt="Test Run Execution" className="doc_img"/>
284
303
@@ -300,7 +319,7 @@ This intelligent reporting dramatically reduces the time from test completion to
0 commit comments