Merge pull request #9 from bishalprasad321/develop

Release developed changes to main

Author: bishalprasad321

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @bishalprasad321

.github/workflows/action-test.yml

@@ -69,7 +69,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           llm_api_key: ${{ secrets.GROQ_API_KEY }}
           llm_provider: groq
-          ai_model: groq-1.5-mini
+          ai_model: openai/gpt-oss-120b
           max_diff_lines: "5000"
           enable_incremental_diff_processing: "true"
           debug: ${{ inputs.debug_enabled || 'false' }}
@@ -207,67 +207,3 @@ jobs:
             echo "  - LLM API is temporarily unavailable"
           fi
           echo "=========================================="
-
-  # ============================================================================
-  # Integration Test Summary
-  # ============================================================================
-  # Summarize both steps and provide overall status
-  # ============================================================================
-  test-summary:
-    name: "Integration Test Summary"
-    needs: [generate-description, consensus-review]
-    runs-on: ubuntu-latest
-    if: always()
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Create Integration Test Report
-        uses: actions/github-script@v7
-        if: github.event_name == 'pull_request'
-        with:
-          script: |
-            const generateDescStatus = '${{ needs.generate-description.result }}';
-            const consensusReviewStatus = '${{ needs.consensus-review.result }}';
-
-            let reportBody = '## 🤖 AI Review Workflow Report\n\n';
-            reportBody += '### Step 1: PR Description Generation\n';
-            reportBody += `- Status: ${generateDescStatus === 'success' ? '✅ Success' : '⚠️ ' + generateDescStatus}\n\n`;
-
-            reportBody += '### Step 2: Multi-Model Consensus Review\n';
-            reportBody += `- Status: ${consensusReviewStatus === 'success' ? '✅ Success' : '⚠️ ' + consensusReviewStatus}\n`;
-            reportBody += `- Decision: ${{ needs.consensus-review.outputs.review_decision || 'N/A' }}\n`;
-            reportBody += `- Consensus Round: ${{ needs.consensus-review.outputs.consensus_round || 'N/A' }}\n\n`;
-
-            reportBody += '### Workflow Status\n';
-            const allSuccess = generateDescStatus === 'success' && consensusReviewStatus === 'success';
-            reportBody += allSuccess 
-              ? '✅ **All steps completed successfully**\n'
-              : '⚠️ **One or more steps encountered issues** (check logs for details)\n';
-
-            reportBody += '\n---\n';
-            reportBody += '*Models Used:* Review [MODELS_AND_OPTIMIZATION.md](../../MODELS_AND_OPTIMIZATION.md) for configuration details\n';
-            reportBody += '*This report was generated by the PR Pilot Review Integration Tests*\n';
-
-            console.log(reportBody);
-
-      - name: Print Workflow Summary
-        run: |
-          echo "=========================================="
-          echo "Integration Test Workflow Summary"
-          echo "=========================================="
-          echo ""
-          echo "Jobs Status:"
-          echo "  Generate Description: ${{ needs.generate-description.result }}"
-          echo "  Consensus Review: ${{ needs.consensus-review.result }}"
-          echo ""
-          echo "Consensus Review Outputs:"
-          echo "  Decision: ${{ needs.consensus-review.outputs.review_decision }}"
-          echo "  Round: ${{ needs.consensus-review.outputs.consensus_round }}"
-          echo "  Review ID: ${{ needs.consensus-review.outputs.review_id }}"
-          echo ""
-          echo "💡 Tips:"
-          echo "  - Run with debug_enabled=true for verbose model output"
-          echo "  - Try different model presets for cost/quality trade-offs"
-          echo "  - See MODELS_AND_OPTIMIZATION.md for detailed configuration"

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Create a Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*" # Trigger on tags like v1.0.0, v2.1.3, etc.
+
+jobs:
+  create-release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref_name }}
+          release_name: ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+
+  update-majorver:
+    name: Update Major Version
+    runs-on: ubuntu-latest
+    needs: create-release
+    permissions:
+      contents: write
+
+    steps:
+      - name: Update Major Version Tag
+        uses: nowactions/update-majorver@v1

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to PR Pilot Review
+
+We welcome contributions to the PR Pilot Review project! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.
+
+## Getting Started
+
+1. **Fork the repository** on GitHub.
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/your-username/prpilot-review.git
+   cd prpilot-review
+   ```
+3. **Add the upstream remote**:
+   ```bash
+   git remote add upstream https://github.com/bishalprasad321/prpilot-review.git
+   ```
+
+## Development Process
+
+Please refer to the [Development Guide](DEVELOPMENT.md) for detailed instructions on setting up your local environment, available scripts, and testing procedures.
+
+### Workflow
+
+1. Ensure your local `main` branch is up to date with the `upstream` repository.
+2. **Create a feature branch**:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+3. **Make your changes**. Keep your commits focused and provide clear, descriptive commit messages.
+4. **Test thoroughly**. Run the full suite of checks to ensure your changes meet the project's quality standards:
+   ```bash
+   npm run all
+   ```
+5. **Build the distributable**. The GitHub Action consumes the compiled bundle in the `dist/` directory. You must rebuild it before committing:
+   ```bash
+   npm run build
+   git add dist/
+   ```
+6. **Commit your changes**:
+   ```bash
+   git commit -m "Brief description of the changes"
+   ```
+7. **Push to your fork**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+## Pull Request Guidelines
+
+- **Open a Pull Request** against the `main` or `develop` branch of the upstream repository.
+- **Describe your changes** clearly in the PR description. Detail what was changed, why it was changed, and any related issue numbers.
+- Ensure all CI status checks pass. If tests fail, investigate and fix the underlying issues.
+- Be prepared to discuss your code and address review feedback.
+
+## Code Standards
+
+- **TypeScript**: The project is written in TypeScript. Ensure all new code is strongly typed and passes the `npm run typecheck` validation.
+- **Formatting**: We use Prettier for consistent code formatting. Run `npm run format` before committing.
+- **Linting**: We use ESLint to catch potential errors and enforce code style. Address any warnings or errors reported by `npm run lint`.
+- **Testing**: Include tests for new features and bug fixes. Existing tests must not be broken by your changes.
+
+Thank you for contributing!

DEVELOPMENT.md

@@ -0,0 +1,87 @@
+# Development Guide
+
+This guide outlines how to set up the PR Pilot Review project for local development, run tests, and build the action.
+
+## Prerequisites
+
+Ensure you have the following installed on your development machine:
+
+- Node.js (Version 20 or higher)
+- npm (Version 10 or higher)
+- Git
+
+## Initial Setup
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/bishalprasad321/prpilot-review.git
+   cd prpilot-review
+   ```
+
+2. Install project dependencies:
+   ```bash
+   npm install
+   ```
+
+## Development Workflow
+
+The source code is located in the `src/` directory. The project uses TypeScript.
+
+### Available Scripts
+
+The following npm scripts are available for development:
+
+- `npm run typecheck`: Validates TypeScript types.
+- `npm run lint`: Runs ESLint to check for code quality issues.
+- `npm run format`: Automatically fixes formatting issues using Prettier.
+- `npm run test`: Runs the Jest test suite.
+- `npm run build`: Bundles the action using `@vercel/ncc` into the `dist/` directory.
+- `npm run verify`: Verifies the generated bundle.
+- `npm run all`: Runs formatting, linting, typechecking, tests, and the build process sequentially.
+
+### Making Changes
+
+1. Create a new branch for your feature or bugfix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+2. Make your modifications within the `src/` directory.
+3. Ensure your code passes all checks:
+   ```bash
+   npm run all
+   ```
+4. **Important**: The GitHub Action runs from the compiled `dist/index.js` file. You must build the project and commit the `dist/` directory for your changes to take effect in the action.
+   ```bash
+   npm run build
+   git add dist/
+   git commit -m "Build dist bundle"
+   ```
+
+## Testing
+
+### Local Testing
+
+The project uses Jest for unit testing. You can run the tests locally:
+
+```bash
+npm test                    # Run all tests
+npm test -- --watch         # Run tests in watch mode
+npm test -- --coverage      # Generate a coverage report
+```
+
+### Integration Testing
+
+Integration tests are defined in `.github/workflows/action-test.yml`. You can trigger these manually via the GitHub Actions UI:
+
+1. Navigate to the **Actions** tab in your repository.
+2. Select the **Test Action - Multi-Model Consensus Review Integration** workflow.
+3. Click **Run workflow**. You can configure options like `debug_enabled` and `model_preset` before running.
+
+### Testing on a Pull Request
+
+To test your changes in a real PR environment:
+
+1. Push your branch and create a Pull Request against the `develop` or `main` branch.
+2. The action will automatically run against your PR if the workflow is configured.
+3. Review the action logs and the generated PR comments to verify behavior.

QUICKSTART.md

@@ -0,0 +1,96 @@
+# Quick Start Guide
+
+This guide will help you integrate PR Pilot Review into your GitHub repository to enable automated, multi-model consensus code reviews.
+
+## Prerequisites
+
+Before setting up the action, you need an API key from a supported LLM provider.
+
+1. **Choose your LLM provider:** The action currently supports `gemini` and `groq`.
+2. **Obtain an API key:** Register or log in to your chosen provider's platform to generate an API key.
+   - For Gemini: Google AI Studio
+   - For Groq: Groq Console
+
+## Configuration Steps
+
+### 1. Add the API key to GitHub Secrets
+
+You need to store your API key securely in your GitHub repository.
+
+1. Navigate to your repository on GitHub.
+2. Go to **Settings** > **Secrets and variables** > **Actions**.
+3. Click **New repository secret**.
+4. Name the secret appropriately (e.g., `GROQ_API_KEY` or `GEMINI_API_KEY`).
+5. Paste your API key as the secret value and save.
+
+### 2. Enable GitHub Actions to Approve Pull Requests
+
+For the bot to successfully submit an "APPROVE" or "REQUEST_CHANGES" review decision, you must explicitly grant this permission in your repository settings.
+
+1. Navigate to your repository on GitHub.
+2. Go to **Settings** > **Actions** > **General**.
+3. Scroll down to the **Workflow permissions** section.
+4. Ensure the checkbox for **Allow GitHub Actions to create and approve pull requests** is checked.
+5. Click **Save**.
+
+_(Note: If this setting is not enabled, the action will still be able to post regular comments, but may fail when attempting to submit a formal approval or change request)._
+
+### 3. Set up the Workflow File
+
+Create a new file in your repository at `.github/workflows/ai-review.yml` and add the following configuration:
+
+```yaml
+name: AI Code Review
+
+on:
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  ai-review:
+    name: Multi-Model AI Review
+    runs-on: ubuntu-latest
+
+    permissions:
+      pull-requests: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: bishalprasad321/prpilot-review@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          llm_provider: groq
+          llm_api_key: ${{ secrets.GROQ_API_KEY }}
+
+          # Optional: Use Groq's OpenAI-compatible API
+          llm_provider_url: https://api.groq.com/openai/v1
+```
+
+### 3. Advanced Configuration (Optional)
+
+You can customize the models used for review and the behavior of the action.
+
+```yaml
+- uses: bishalprasad321/prpilot-review@v1
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    llm_provider: groq
+    llm_api_key: ${{ secrets.GROQ_API_KEY }}
+    llm_provider_url: https://api.groq.com/openai/v1
+
+    # Customize model configuration
+    reviewer_models: "llama-3.1-8b-instant,openai/gpt-oss-20b,llama-3.3-70b-versatile"
+    judge_model: "openai/gpt-oss-120b"
+
+    # Adjust consensus parameters
+    max_consensus_rounds: "3"
+
+    # Feature toggles
+    inline_comments_enabled: "true"
+    max_diff_lines: "5000"
+    enable_incremental_diff_processing: "true"
+```
+
+For more detailed information on inputs, outputs, and configuration options, please refer to the [API Reference](docs/api.md).