Improve general structure

canack · canack · commit 164b34ce0251 · 2025-01-20T00:36:06.000+03:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,25 @@
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+        - name: Checkout
+          uses: actions/checkout@v4
+        - name: install docker emulation
+          run: docker run --rm --privileged tonistiigi/binfmt:latest --install amd64,arm64
+        - name: Set up buildx
+          uses: docker/setup-buildx-action@v3
+        - name: Login to ghcr.io
+          run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+        - name: Build and push
+          run: |
+            docker buildx build --platform linux/amd64,linux/arm64 -t $(echo 'ghcr.io/${{ github.repository }}:${{ github.ref_name }}' | tr '[:upper:]' '[:lower:]') --push . 
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -0,0 +1,27 @@
+name: Release Creation
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    name: Create a Draft Release on GitHub
+    runs-on: ubuntu-latest
+    steps:
+    - name: Get Release Name
+      id: get_release_name
+      run: |
+        echo "release_name=${GITHUB_REF_NAME/v/Version }" >> $GITHUB_ENV
+    - name: Publish a Draft Release
+      uses: softprops/action-gh-release@v2
+      with:
+        body: |
+          ## What's Changed
+
+          **Changelog:**
+        draft: true  # Creates a Draft Release
+        name: ${{ steps.get_release_name.outputs.release_name }}
+        generate_release_notes: true
+        append_body: true 
diff --git a/.gitignore b/.gitignore
@@ -1,25 +1,37 @@
-# Binaries
-/bin
+# Binaries for programs and plugins
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
+bin/
 
-# Test binary
+# Test binary, built with `go test -c`
 *.test
 
-# Output of the go coverage tool
+# Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
-# Dependency directories
-/vendor/
+# Dependency directories (remove the comment below to include it)
+vendor/
+
+# Go workspace file
+go.work
 
 # IDE specific files
 .idea/
 .vscode/
 *.swp
-*.swo 
+*.swo
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
 
 # sample workflow
 .github/workflows/issue-assistant.yml
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 WorkflowKit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 
diff --git a/README.md b/README.md
@@ -17,48 +17,9 @@ AI-powered GitHub Issue assistant that provides intelligent responses based on r
 - 🧠 Multiple AI model support (OpenAI, Claude)
 - 📋 Customizable response templates
 
-## Requirements
+## Quick Start
 
-- Go 1.23 or higher
-- GitHub Personal Access Token (PAT) with `repo` scope
-- AI API Key (OpenAI or Anthropic)
-- Docker (optional, for containerized running)
-
-## Environment Variables
-
-| Variable | Description | Required | Default |
-|----------|-------------|----------|---------|
-| `GITHUB_TOKEN` | GitHub PAT with repo scope | Yes | - |
-| `OPENAI_API_KEY` | OpenAI API Key | Yes* | - |
-| `CLAUDE_API_KEY` | Anthropic Claude API Key | Yes* | - |
-| `AI_TYPE` | AI model type (openai/claude) | Yes | - |
-
-*Either OPENAI_API_KEY or CLAUDE_API_KEY is required based on AI_TYPE
-
-## Project Structure
-
-```
-.
-├── cmd/
-│   └── issue-assistant/
-├── internal/
-│   └── helper/
-├── pkg/
-│   ├── ai/
-│   ├── github/
-│   └── logger/
-└── .github/
-    └── workflows/
-```
-
-## Setup
-
-1. Create required secrets in your repository:
-   - `GITHUB_TOKEN`: GitHub token with repo scope (automatically provided by GitHub Actions)
-   - `OPENAI_API_KEY`: Your OpenAI API key (if using OpenAI)
-   - `CLAUDE_API_KEY`: Your Claude API key (if using Claude)
-
-2. Add the following workflow file to your repository (`.github/workflows/issue-assistant.yml`):
+1. Add this workflow to your repository (`.github/workflows/issue-assistant.yml`):
 
 ```yaml
 name: Issue Assistant
@@ -73,56 +34,71 @@ jobs:
       issues: write
       contents: read
     steps:
-      - uses: actions/checkout@v3
+      - uses: workflowkit/issue-assistant@v1
         with:
-          repository: workflowkit/issue-assistant
-          token: ${{ secrets.GITHUB_TOKEN }}
-          path: .issue-assistant
-      
-      - name: Build and run assistant
-        working-directory: .issue-assistant
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          AI_TYPE: "openai"  # or "claude"
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-          CLAUDE_API_KEY: ${{ secrets.CLAUDE_API_KEY }}
-        run: |
-          docker build -t issue-assistant .
-          docker run --rm \
-            -e GITHUB_TOKEN \
-            -e AI_TYPE \
-            -e OPENAI_API_KEY \
-            -e CLAUDE_API_KEY \
-            -e GITHUB_EVENT_PATH \
-            -v $GITHUB_EVENT_PATH:$GITHUB_EVENT_PATH \
-            issue-assistant
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          ai_type: "openai"  # or "claude"
+          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
+          # claude_api_key: ${{ secrets.CLAUDE_API_KEY }}  # if using claude
+          enable_comment: "true"   # required: at least one feature must be enabled
+          enable_label: "false"    # required: at least one feature must be enabled
 ```
 
-## How It Works
+2. Add required secrets to your repository:
+   - `OPENAI_API_KEY` (if using OpenAI)
+   - `CLAUDE_API_KEY` (if using Claude)
 
-1. When a new issue is opened, the workflow is triggered
-2. The assistant reads the repository content
-3. OpenAI GPT-4 analyzes the issue and repository content
-4. A detailed response is posted as a comment on the issue
-5. Confidence scoring ensures high-quality responses
+That's it! Now when someone opens an issue:
+- AI will analyze the issue content
+- AI will analyze your repository code
+- AI will post a helpful response as a comment
+- Optionally, AI can suggest labels
 
-## Development
+## Configuration Options
 
-```bash
-# Clone the repository
-git clone https://github.com/workflowkit/issue-assistant.git
+| Option | Description | Required | Default |
+|--------|-------------|----------|---------|
+| `github_token` | GitHub token (automatically provided) | Yes | - |
+| `ai_type` | AI model to use (`openai` or `claude`) | Yes | - |
+| `openai_api_key` | OpenAI API Key | Yes* | - |
+| `claude_api_key` | Claude API Key | Yes* | - |
+| `enable_comment` | Enable AI comments on issues | Yes** | false |
+| `enable_label` | Enable AI label suggestions | Yes** | false |
 
-# Install dependencies
-go mod tidy
+*Either `openai_api_key` or `claude_api_key` is required based on `ai_type`
+**At least one feature (`enable_comment` or `enable_label`) must be enabled
 
-# Run tests
-go test ./...
+## Advanced Usage
+
+### Using with OpenAI:
+```yaml
+- uses: workflowkit/issue-assistant@v1
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    ai_type: "openai"
+    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
+    enable_comment: "true"
+```
 
-# Build locally
-go build -o bin/issue-assistant
+### Using with Claude:
+```yaml
+- uses: workflowkit/issue-assistant@v1
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    ai_type: "claude"
+    claude_api_key: ${{ secrets.CLAUDE_API_KEY }}
+    enable_label: "true"
+```
 
-# Build Docker image
-docker build -t issue-assistant .
+### Enable All Features:
+```yaml
+- uses: workflowkit/issue-assistant@v1
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    ai_type: "openai"
+    openai_api_key: ${{ secrets.OPENAI_API_KEY }}
+    enable_comment: "true"
+    enable_label: "true"
 ```
 
 ## Contributing
diff --git a/action.yml b/action.yml
@@ -1,8 +1,16 @@
 name: 'Issue Assistant'
-description: 'AI-powered GitHub Issue assistant that provides intelligent responses based on repository content'
+description: 'AI-powered GitHub Issue assistant that provides intelligent responses and label suggestions using OpenAI GPT-4 or Anthropic Claude'
+author: 'workflowkit'
+
+# Categories for GitHub Marketplace
+categories:
+  - 'AI'
+  - 'Code Review'
+  - 'Issue Management'
+
 branding:
-  icon: 'message-square'
-  color: 'blue'
+  icon: 'brain'
+  color: 'purple'
 
 inputs:
   github_token:
@@ -21,11 +29,11 @@ inputs:
   enable_comment:
     description: 'Enable AI-powered code analysis comments on issues'
     required: false
-    default: 'true'
+    default: 'false' # Default is false, but you must enable if you want to use this action
   enable_label:
     description: 'Enable AI-powered label suggestions for issues'
     required: false
-    default: 'false'
+    default: 'false' # Default is false, but you must enable if you want to use this action
 
 runs:
   using: 'docker'
diff --git a/internal/helper/helper.go b/internal/helper/helper.go
@@ -247,7 +247,7 @@ func (h *Helper) processLabels(ctx context.Context, event *GitHubEvent) {
 
 // formatLabelExplanation formats the label explanation as a GitHub issue comment
 func (h *Helper) formatLabelExplanation(labels []string, explanation string) string {
-	return fmt.Sprintf(`🏷️ AI Label Analysis
+	return fmt.Sprintf(`🏷️ AI Label Assistant
 
 I've added the following labels to this issue:
 %s
@@ -273,7 +273,7 @@ func formatLabelList(labels []string) string {
 
 // formatComment formats the AI response as a GitHub issue comment
 func (h *Helper) formatComment(answer string) string {
-	return fmt.Sprintf(`🤖 AI Assistant Analysis
+	return fmt.Sprintf(`🤖 AI Issue Assistant
 
 %s
 
