Skip to content

SIMILI_SETUP.md

Latest commit

 

History

History
59 lines (47 loc) · 2 KB

SIMILI_SETUP.md

File metadata and controls

59 lines (47 loc) · 2 KB

Simili-Bot Integration Setup

This repository is configured for Simili-Bot automatic issue triage and similarity detection.

Configuration

  • Config File: .github/simili.yaml
  • Extends: similigh/simili-shared-config@main
  • Workflow: .github/workflows/issue-triage.yml

Features Enabled

✅ Cross-Repository Similarity Search (cross_repo_search: true) ✅ Transfer Loop Prevention (EventAction field) ✅ Table-Formatted Similar Issues Display ✅ Markdown Table Format for Better UX

Tested Scenarios

Scenario 1: Cross-Repo Similarity

  • Core Issue #94: "User authentication flow enhancement"
  • CLI Issue #35: "Authentication system improvements"
  • SDK Issue #60: "API authentication enhancement"

These issues are matched as similar with ~80-85% similarity due to shared authentication context.

Scenario 2: Transfer Loop Prevention

When an issue is transferred from one repo to another:

  1. Bot detects "transferred" event action
  2. Skips re-triage with message: "transferred from another repository"
  3. Prevents 100% self-duplicate match

Scenario 3: Table Formatting

Similar issues are displayed in clean markdown table format:

| Issue | Title | Similarity | State |
|-------|-------|------------|-------|
| [#35](url) | Authentication system improvements | 82% | open |

Verification Checklist

  • Repository configured in simili.yaml
  • Workflow triggers on issue.opened and issue.edited
  • Cross-repo search enabled
  • Similar issues table formatting applied
  • Transfer loop prevention working

Testing the Bot

To manually trigger the bot on an existing issue:

cd /Users/kaviru/Downloads/simili-bot
./simili-cli process --issue <json_event> --config /tmp/simili-integration/simili-shared-config/.github/simili.yaml --dry-run

Repos in Integration

  • event-integrator-core (main server engine)
  • event-integrator-cli (CLI interface)
  • event-integrator-sdk (Client libraries)
  • event-integrator-docs (Documentation)
  • event-integrator-vscode (VS Code extension)