feat: filter out common large files

Author: robaone-redshelf

.github/actions/auto-pr-description/README.md

@@ -8,6 +8,7 @@ A reusable GitHub Action that automatically generates pull request descriptions
 - 🎯 **Smart Formatting**: Generates structured descriptions with Description, Changes, and Verification sections
 - 🖼️ **Image Preservation**: Maintains existing images at the top of PR descriptions
 - 🎫 **JIRA Integration**: Automatically extracts JIRA ticket IDs and adds ticket links
+- 🚫 **Smart Filtering**: Automatically ignores large files like package-lock.json to prevent token size issues
 - ⚡ **Fast & Lightweight**: Minimal dependencies and quick execution
 
 ## Usage
@@ -64,6 +65,7 @@ jobs:
 | `github-token` | GitHub token for PR operations | ✅ | - |
 | `pr-number` | Pull request number | ✅ | - |
 | `jira-ticket-url-prefix` | JIRA ticket URL prefix | ❌ | `https://virdocs.atlassian.net/browse/` |
+| `ignore-files` | Comma-separated list of files to ignore in diff | ❌ | `package-lock.json,yarn.lock,pnpm-lock.yaml,composer.lock,Gemfile.lock,poetry.lock,Pipfile.lock` |
 
 ## Outputs
 
@@ -152,6 +154,28 @@ The action handles various error scenarios:
     # ... other inputs
 ```
 
+### Custom File Filtering
+By default, the action ignores common lock files that can be very large and don't provide meaningful context for PR descriptions. You can customize which files to ignore:
+
+```yaml
+- uses: ./.github/actions/auto-pr-description
+  with:
+    ignore-files: 'package-lock.json,yarn.lock,dist/bundle.js,build/'
+    # ... other inputs
+```
+
+**Default ignored files:**
+- `package-lock.json` (npm)
+- `yarn.lock` (Yarn)
+- `pnpm-lock.yaml` (pnpm)
+- `composer.lock` (PHP Composer)
+- `Gemfile.lock` (Ruby Bundler)
+- `poetry.lock` (Python Poetry)
+- `Pipfile.lock` (Python Pipenv)
+
+**Why filter files?**
+Large files like lock files can cause the AI API to hit token limits, resulting in failed PR description generation. By filtering these files, the action focuses on meaningful code changes while staying within API limits.
+
 ### Using Outputs
 ```yaml
 - name: Generate PR Description
@@ -172,7 +196,7 @@ The action handles various error scenarios:
 
 1. **Missing API Key**: Ensure `GEMINI_API_KEY` is set in repository secrets
 2. **Permission Denied**: Check that workflow has `pull-requests: write` permission
-3. **Large Diffs**: Very large changes might exceed API limits - consider smaller PRs
+3. **Large Diffs**: Very large changes might exceed API limits - use `ignore-files` to filter out large files or consider smaller PRs
 4. **Rate Limits**: Gemini API has rate limits - add delays between calls if needed
 5. **Invalid PR Number**: Ensure the PR number is valid and accessible
 

.github/actions/auto-pr-description/action.yml

@@ -14,6 +14,10 @@ inputs:
     description: 'JIRA ticket URL prefix (e.g., https://company.atlassian.net/browse/)'
     required: false
     default: 'https://virdocs.atlassian.net/browse/'
+  ignore-files:
+    description: 'Comma-separated list of files to ignore in the diff (e.g., package-lock.json,yarn.lock)'
+    required: false
+    default: 'package-lock.json,yarn.lock,pnpm-lock.yaml,composer.lock,Gemfile.lock,poetry.lock,Pipfile.lock'
 outputs:
   description:
     description: 'The generated PR description'
@@ -41,10 +45,18 @@ runs:
       env:
         GH_TOKEN: ${{ inputs.github-token }}
         PR_NUMBER: ${{ inputs.pr-number }}
+        IGNORE_FILES: ${{ inputs.ignore-files }}
       run: |
         # Get the PR diff directly from GitHub using gh CLI
         gh pr diff ${{ inputs.pr-number }} > pr.diff
         echo "Generated diff file with $(wc -l < pr.diff) lines"
+        
+        # Filter out ignored files from the diff
+        if [ -n "$IGNORE_FILES" ]; then
+          echo "Filtering out ignored files: $IGNORE_FILES"
+          node ${{ github.action_path }}/filter_diff.js pr.diff "$IGNORE_FILES"
+          echo "Filtered diff file now has $(wc -l < pr.diff) lines"
+        fi
     
     - name: Generate PR description
       id: generate_description

.github/actions/auto-pr-description/filter_diff.js

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+
+/**
+ * Filters out specified files from a git diff
+ * Usage: node filter_diff.js <diff_file> <ignore_files_comma_separated>
+ */
+
+function filterDiff(diffContent, ignoreFiles) {
+  if (!ignoreFiles || ignoreFiles.trim() === '') {
+    return diffContent;
+  }
+
+  const filesToIgnore = ignoreFiles.split(',').map(f => f.trim()).filter(f => f.length > 0);
+  if (filesToIgnore.length === 0) {
+    return diffContent;
+  }
+
+  const lines = diffContent.split('\n');
+  const filteredLines = [];
+  let currentFile = null;
+  let skipCurrentFile = false;
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+    
+    // Check if this is a file header line (starts with diff --git)
+    if (line.startsWith('diff --git ')) {
+      // Extract the file path from the diff header
+      // Format: diff --git a/path/to/file b/path/to/file
+      const match = line.match(/diff --git a\/(.+?) b\/(.+?)$/);
+      if (match) {
+        currentFile = match[1]; // Use the 'a/' path
+        
+        // Check if this file should be ignored
+        skipCurrentFile = filesToIgnore.some(ignoreFile => {
+          // Support both exact matches and basename matches
+          return currentFile === ignoreFile || currentFile.endsWith('/' + ignoreFile) || currentFile === ignoreFile;
+        });
+        
+        if (skipCurrentFile) {
+          // Skip all lines until the next file or end of diff
+          while (i + 1 < lines.length && !lines[i + 1].startsWith('diff --git ')) {
+            i++;
+          }
+          continue;
+        }
+      }
+    }
+    
+    // If we're not skipping the current file, include the line
+    if (!skipCurrentFile) {
+      filteredLines.push(line);
+    }
+  }
+
+  return filteredLines.join('\n');
+}
+
+// Main execution
+if (require.main === module) {
+  const [, , diffFile, ignoreFiles] = process.argv;
+  
+  if (!diffFile) {
+    console.error('Usage: filter_diff.js <diff_file> <ignore_files_comma_separated>');
+    process.exit(1);
+  }
+
+  if (!fs.existsSync(diffFile)) {
+    console.error(`Error: Diff file not found at ${diffFile}`);
+    process.exit(1);
+  }
+
+  try {
+    const diffContent = fs.readFileSync(diffFile, 'utf8');
+    const filteredDiff = filterDiff(diffContent, ignoreFiles || '');
+    
+    // Write filtered diff back to the same file
+    fs.writeFileSync(diffFile, filteredDiff, 'utf8');
+    
+    // Output statistics
+    const originalLines = diffContent.split('\n').length;
+    const filteredLines = filteredDiff.split('\n').length;
+    const removedLines = originalLines - filteredLines;
+    
+    console.error(`Filtered diff: removed ${removedLines} lines (${originalLines} -> ${filteredLines})`);
+    if (ignoreFiles) {
+      console.error(`Ignored files: ${ignoreFiles}`);
+    }
+  } catch (error) {
+    console.error(`Error filtering diff: ${error.message}`);
+    process.exit(1);
+  }
+}
+
+module.exports = { filterDiff };

.github/actions/auto-release-description/README.md

@@ -0,0 +1,213 @@
+# Auto PR Description Generator
+
+A reusable GitHub Action that automatically generates pull request descriptions using AI (Google Gemini) based on the git diff of changes.
+
+## Features
+
+- 🤖 **AI-Powered**: Uses Google Gemini to analyze code changes and generate meaningful descriptions
+- 🎯 **Smart Formatting**: Generates structured descriptions with Description, Changes, and Verification sections
+- 🖼️ **Image Preservation**: Maintains existing images at the top of PR descriptions
+- 🎫 **JIRA Integration**: Automatically extracts JIRA ticket IDs and adds ticket links
+- 🚫 **Smart Filtering**: Automatically ignores large files like package-lock.json to prevent token size issues
+- ⚡ **Fast & Lightweight**: Minimal dependencies and quick execution
+
+## Usage
+
+### Basic Usage
+
+```yaml
+- name: Generate PR Description
+  uses: ./.github/actions/auto-pr-description
+  with:
+    gemini-api-key: ${{ secrets.GEMINI_API_KEY }}
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+    pr-number: ${{ github.event.pull_request.number }}
+```
+
+### Complete Workflow Example
+
+```yaml
+name: Auto PR Description
+on:
+  pull_request:
+    types: [labeled]
+
+jobs:
+  update-pr-description:
+    name: Update PR Description
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'pull_request' &&
+      github.base_ref == 'main' &&
+      (github.event.pull_request.draft == false || github.event.action == 'labeled') &&
+      (contains(github.event.pull_request.labels.*.name, 'auto-pr-description') || 
+       contains(github.event.pull_request.labels.*.name, 'test'))
+    permissions:
+      pull-requests: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Generate PR Description
+        uses: ./.github/actions/auto-pr-description
+        with:
+          gemini-api-key: ${{ secrets.GEMINI_API_KEY }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          pr-number: ${{ github.event.pull_request.number }}
+          jira-ticket-url-prefix: 'https://yourcompany.atlassian.net/browse/'
+```
+
+## Inputs
+
+| Input | Description | Required | Default |
+|-------|-------------|----------|---------|
+| `gemini-api-key` | The API key for the Gemini API | ✅ | - |
+| `github-token` | GitHub token for PR operations | ✅ | - |
+| `pr-number` | Pull request number | ✅ | - |
+| `jira-ticket-url-prefix` | JIRA ticket URL prefix | ❌ | `https://virdocs.atlassian.net/browse/` |
+| `ignore-files` | Comma-separated list of files to ignore in diff | ❌ | `package-lock.json,yarn.lock,pnpm-lock.yaml,composer.lock,Gemfile.lock,poetry.lock,Pipfile.lock` |
+
+## Outputs
+
+| Output | Description |
+|--------|-------------|
+| `description` | The generated PR description |
+| `updated` | Whether the PR description was updated |
+
+## Generated Description Format
+
+The action generates PR descriptions in this structured format:
+
+```markdown
+## Description
+A concise summary of what the changes accomplish.
+
+## Changes
+- [ ] Specific change or feature added
+- [ ] Another modification made
+- [ ] Bug fix or improvement
+
+## Verification
+- [ ] Test that should be performed
+- [ ] Verification step to confirm functionality
+- [ ] Additional checks recommended
+
+## Ticket
+https://yourcompany.atlassian.net/browse/TICKET-123
+```
+
+## JIRA Integration
+
+The action automatically detects JIRA ticket IDs from:
+1. **PR Title**: Extracts patterns like `CORE-1234`, `PAR-567`, etc.
+2. **Branch Name**: Falls back to branch name if not found in title
+
+Example branch names that work:
+- `CORE-1234-feature-description`
+- `PAR-567-bug-fix`
+- `feature/CORE-1234-new-feature`
+
+## Prerequisites
+
+### Required Secrets
+
+1. **GEMINI_API_KEY**: Get your API key from [Google AI Studio](https://makersuite.google.com/app/apikey)
+2. **GITHUB_TOKEN**: Automatically provided by GitHub Actions
+
+### Required Permissions
+
+The workflow must have these permissions:
+```yaml
+permissions:
+  pull-requests: write
+  contents: read
+```
+
+## Trigger Patterns
+
+### Label-Based Triggering
+Add these labels to trigger the action:
+- `auto-pr-description`: Specific label for PR description generation
+- `test`: Dual-purpose label that can trigger both testing and description generation
+
+### Draft Mode Handling
+- **Draft PRs**: Action doesn't run automatically to save CI resources
+- **Label Override**: Adding trigger labels to draft PRs will run the action
+- **Ready for Review**: Converting draft to ready automatically triggers the action
+
+## Error Handling
+
+The action handles various error scenarios:
+- Missing or invalid Gemini API key
+- API rate limits and timeouts
+- Large diffs that exceed API limits
+- Network connectivity issues
+- Invalid PR numbers
+
+## Customization
+
+### Custom JIRA URL
+```yaml
+- uses: ./.github/actions/auto-pr-description
+  with:
+    jira-ticket-url-prefix: 'https://mycompany.atlassian.net/browse/'
+    # ... other inputs
+```
+
+### Custom File Filtering
+By default, the action ignores common lock files that can be very large and don't provide meaningful context for PR descriptions. You can customize which files to ignore:
+
+```yaml
+- uses: ./.github/actions/auto-pr-description
+  with:
+    ignore-files: 'package-lock.json,yarn.lock,dist/bundle.js,build/'
+    # ... other inputs
+```
+
+**Default ignored files:**
+- `package-lock.json` (npm)
+- `yarn.lock` (Yarn)
+- `pnpm-lock.yaml` (pnpm)
+- `composer.lock` (PHP Composer)
+- `Gemfile.lock` (Ruby Bundler)
+- `poetry.lock` (Python Poetry)
+- `Pipfile.lock` (Python Pipenv)
+
+**Why filter files?**
+Large files like lock files can cause the AI API to hit token limits, resulting in failed PR description generation. By filtering these files, the action focuses on meaningful code changes while staying within API limits.
+
+### Using Outputs
+```yaml
+- name: Generate PR Description
+  id: pr-desc
+  uses: ./.github/actions/auto-pr-description
+  with:
+    # ... inputs
+
+- name: Use generated description
+  run: |
+    echo "Generated description: ${{ steps.pr-desc.outputs.description }}"
+    echo "Was updated: ${{ steps.pr-desc.outputs.updated }}"
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Missing API Key**: Ensure `GEMINI_API_KEY` is set in repository secrets
+2. **Permission Denied**: Check that workflow has `pull-requests: write` permission
+3. **Large Diffs**: Very large changes might exceed API limits - use `ignore-files` to filter out large files or consider smaller PRs
+4. **Rate Limits**: Gemini API has rate limits - add delays between calls if needed
+5. **Invalid PR Number**: Ensure the PR number is valid and accessible
+
+### Debug Mode
+
+Enable debug logging by setting:
+```yaml
+env:
+  ACTIONS_STEP_DEBUG: true
+```
+
+## License
+
+MIT License - see LICENSE file for details.