diff --git a/assets/images/kaneai-github-app/github-app-install-success-page.png b/assets/images/kaneai-github-app/github-app-install-success-page.png new file mode 100644 index 00000000..a42d2497 Binary files /dev/null and b/assets/images/kaneai-github-app/github-app-install-success-page.png differ diff --git a/assets/images/kaneai-github-app/github-repository-selection.png b/assets/images/kaneai-github-app/github-repository-selection.png new file mode 100644 index 00000000..b0275607 Binary files /dev/null and b/assets/images/kaneai-github-app/github-repository-selection.png differ diff --git a/assets/images/kaneai-github-app/install-github-app.png b/assets/images/kaneai-github-app/install-github-app.png index bcdfac08..3ebbc3f6 100644 Binary files a/assets/images/kaneai-github-app/install-github-app.png and b/assets/images/kaneai-github-app/install-github-app.png differ diff --git a/assets/images/kaneai-github-app/integration-success.png b/assets/images/kaneai-github-app/integration-success.png new file mode 100644 index 00000000..0362f65f Binary files /dev/null and b/assets/images/kaneai-github-app/integration-success.png differ diff --git a/assets/images/kaneai-github-app/uninstall-github-app.png b/assets/images/kaneai-github-app/uninstall-github-app.png new file mode 100644 index 00000000..cc99c5cb Binary files /dev/null and b/assets/images/kaneai-github-app/uninstall-github-app.png differ diff --git a/docs/kaneai-github-app.md b/docs/kaneai-github-app.md index 94bf8b6b..7e5f1536 100644 --- a/docs/kaneai-github-app.md +++ b/docs/kaneai-github-app.md @@ -40,8 +40,6 @@ slug: github-app-integration/ > # LambdaTest AI Cloud GitHub App Integration -*** -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. ## 1. Overview @@ -85,9 +83,8 @@ Before implementing the LambdaTest AI Cloud GitHub App in your development workf ### Repository Requirements - **GitHub Repository Access**: Administrative access to the GitHub repositories where you want to install the app -- **Repository README**: A well-documented README.md file in your repository (the AI uses this for contextual understanding of your application) + -> **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. --- @@ -109,7 +106,12 @@ During installation, you'll need to specify which repositories should have acces - **Organization-wide Installation**: Select **All repositories** to enable the app across your entire GitHub organization - **Selective Installation**: Choose **Only select repositories** and specify individual repositories for more granular control -After making your selection, complete the installation and authorize LambdaTest to access the selected repositories. +Trigger KaneAI workflow + +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. + +Trigger KaneAI workflow + :::tip Best Practice 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 Confirm the installation was successful by: 1. Navigating to your GitHub organization's **Settings** page -2. Selecting **Installed GitHub Apps** from the left sidebar -3. Verifying that **LambdaTest AI Cloud** appears in the list of installed applications +2. In left side menu under **Integrations**, click **Applications**. +3. Selecting **Installed GitHub Apps** from the left sidebar +4. Verifying that **LambdaTest AI Cloud** appears in the list of installed applications You can also click on the app to review and modify repository access permissions at any time. - +Trigger KaneAI workflow + +--- + +## 3.1 Uninstalling the GitHub App + +If you need to remove the LambdaTest AI Cloud GitHub App from your organization: + +1. Navigate to the [LambdaTest AI Cloud GitHub App](https://github.com/apps/lambdatest-ai-cloud) on GitHub Marketplace +2. Click on the **Configure** button to access the app settings +3. Scroll down to the bottom of the page to find the **Danger Zone** section +4. Click on the **Uninstall** button to remove the app from your organization +5. Confirm the uninstallation when prompted + +Uninstall GitHub App + +:::tip caution +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. +::: --- @@ -152,7 +173,7 @@ test_url: "https://your-deployed-app-url.com/" |-----------|-------------|---------------| | `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 | | `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 | -| `assignee` | The LambdaTest user ID who will be assigned to test runs | Found in your LambdaTest account profile settings | +| `assignee` | The LambdaTest user ID who will be assigned to test runs for executions | Can be referenced from APIs | | `environment_id` | The target testing environment (browser, OS, device configurations) | Create environments in Test Manager and reference their IDs | | `test_url` | The base URL of your application under test | Your staging or testing environment URL where tests will be executed | @@ -174,8 +195,9 @@ Your final repository structure should look like this: your-repo/ ├── .lambdatest/ │ └── config.yaml # LambdaTest configuration -├── src/ # Your application source code -├── README.md # Detailed project documentation (used by AI) + └── agent.md # Optional file for custom instructions to enhance responses +├── src/ # Your application source code +├── README.md # Detailed project documentation (used by AI) └── ... other project files ``` @@ -202,9 +224,7 @@ The test generation workflow is triggered through a simple comment on any pull r ```bash @LambdaTest Validate this PR #OR -@LambdaTest Generate test cases -#OR -@KaneAI Generate test cases +@KaneAI Validate this PR ``` 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 After you post the trigger comment, KaneAI immediately begins working: 1. **Code Analysis**: The AI examines all code changes in the pull request, including file modifications, additions, and deletions -2. **Context Gathering**: Your repository's README, existing test patterns, and project structure are analyzed to understand application context +2. **Context Gathering**: Your repository's README.md, PR Title, Description, Comments and AGENT.md are analyzed to understand application context 3. **Test Strategy**: Based on the changes and context, the AI determines which areas require testing and what scenarios to cover 4. **Test Generation**: Intelligent test cases are created with appropriate assertions, validations, and edge case handling @@ -235,6 +255,7 @@ As soon as the workflow begins, KaneAI posts a comprehensive progress tracker co - **Current Workflow Status**: Real-time updates on which phase is currently executing - **Test Case Pipeline**: Progress through analysis, generation, authoring, and code generation phases +- **Intelligent Test Case Suggestion**: AI suggests semantically similar test cases present in the project - **Test Run Management**: Execution status, including configuration, triggering, monitoring, and completion - **Reporting Status**: Final report generation and PR approval recommendation @@ -264,7 +285,6 @@ This comment updates dynamically as test authoring progresses, so you can monito To prevent test redundancy and optimize your test suite, KaneAI performs semantic analysis against your existing test inventory: - **Similar Test Identification**: Finds existing tests that cover similar functionality or user scenarios -- **Reusability Recommendations**: Suggests whether to reuse, extend, or replace existing tests - **Test Suite Optimization**: Helps maintain a lean, efficient test suite by preventing duplicate coverage 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: - **Test Run Configuration**: Details about the execution environment, browser matrix, and parallel execution settings - **Real-Time Execution Status**: Live updates as tests run, including pass/fail counts and completion percentage - **HyperExecute Dashboard Link**: Direct access to detailed logs, screenshots, video recordings, and network traces -- **Execution Duration**: Time tracking to help optimize CI/CD pipeline performance Test Run Execution @@ -300,7 +319,7 @@ This intelligent reporting dramatically reduces the time from test completion to -### Enterprise Benefits: Unified Visibility +### Benefits: Unified Visibility The GitHub-native workflow provides critical advantages for enterprise teams: