laurigates / gha-issue-resolution

Analyzes GitHub issues and provides AI-generated suggestions using Gemini
1 stars 0 forks source link

Fix for issue #1 #5

Closed laurigates closed 3 days ago

laurigates commented 3 days ago

This pull request addresses issue #1.

Proposed solution:

Analysis

The issue is that the documentation for the workflow lacks a proper introduction and examples. This makes it difficult for users to understand the purpose and functionality of the workflow.

Files to Modify

Solution

File: README.md

### Issue Resolution Workflow

This workflow utilizes the Gemini AI platform to analyze GitHub issues and provide AI-generated suggestions. It assists in automating issue management tasks, such as issue classification, labeling, and suggested responses. The workflow runs daily, scans newly opened or reopened issues, and generates suggestions based on Gemini's analysis.

### Usage

**Automatic issue analysis:** The workflow runs automatically on a daily schedule, analyzing newly opened or reopened issues.

**Manual triggering:** The workflow can be manually triggered using the "Actions" tab in the repository.

**Custom configuration:** The workflow can be customized by providing specific issue labels or filters in the workflow file.

### Example Workflow File

```yaml
name: Issue Resolution

on:
  issues:
    types: [opened, reopened]
  schedule:
    - cron: '0 0 * * *'  # Run daily at midnight
  workflow_dispatch:  # Allow manual triggering

jobs:
  resolve_issues:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Issue Resolution with Gemini
      uses: laurigates/gha-issue-resolution@v1
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        gemini_api_key: ${{ secrets.GEMINI_API_KEY }}
        issue_labels: [bug, feature, question]  # Custom issue labels for analysis