Skip to content

Latest commit

 

History

History
141 lines (98 loc) · 4.92 KB

README.md

File metadata and controls

141 lines (98 loc) · 4.92 KB
Raw

doppelgänger

Problem: open-source maintainers spend a lot of time managing duplicate/related (doppelgänger) issues & pull requests
Solution: doppelgänger compares newly submitted issues/PRs against existing ones to automatically flag duplicate/related (doppelgänger) issues/PRs

Topics: vector db, github, open-source, embedding search, rag, similarity scores

Screen.Recording.2024-04-27.at.4.57.11.PM.mov

This application is a GitHub App that automatically compares newly opened issues with existing ones, closing and commenting on highly similar issues to reduce duplication. In addition, it comments feedback on PRs based on title and description for points to consider.

Doppelganger Documentation

Prerequisites

  • Python 3.8+
  • A GitHub account
  • A server or hosting platform to run the app (e.g., Heroku, DigitalOcean, AWS)
  • ollama

Setup Instructions

1. Create a GitHub App

  1. Go to your GitHub account settings.
  2. Click on "Developer settings" in the left sidebar.
  3. Select "GitHub Apps" and click "New GitHub App".
  4. Fill in the required information:
    • GitHub App name: Choose a unique name (e.g., "Issue Similarity Checker")
    • Homepage URL: Your app's website or your GitHub profile
    • Webhook URL: The URL where your server will be running (e.g., https://your-server.com/webhook)
    • Webhook secret: Generate a secure secret and save it for later use
  5. Set permissions:
    • Repository permissions:
      • Issues: Read & write
      • Pull requests: Read & Write
      • Webhooks: Read-only
    • Subscribe to events:
      • Issues
      • Pull request
  6. Create the app and note down the App ID
  7. Generate a private key and download it (you'll need this later)

2. Prepare Your Environment

  1. Clone this repository:

    git clone https://github.com/dannyl1u/doppelganger.git
cd doppelganger

  2. Install dependencies:

    pip install -r requirements.txt

  3. To create a new .env file, run the following command in your terminal:

cp .env.example .env

Open the newly created .env file and update the following variables with your own values:
* APP_ID: Replace your_app_id_here with your actual app ID.
* WEBHOOK_SECRET: Replace your_webhook_secret_here with your actual webhook secret.
* OLLAMA_MODEL: Replace your_chosen_llm_model_here with your chosen LLM model (e.g. "llama3.2"). Note: it must be an Ollama supported model (see: https://ollama.com/library for supported models)

  1. Place the downloaded private key in the project root and name it rsa.pem.

  2. Run the application locally

Start the Flask application:

python3 app.py

The application will start running on http://localhost:4000

3. Deploy the Application (ngrok instructions)

  1. We will use ngrok for its simplicity

In a new terminal window, start ngrok to create a secure tunnel to your local server:

ngrok http 4000

ngrok will generate a public URL (e.g., https://abc123.ngrok.io)

Append /webhook to the url, e.g. https://abc123.ngrok.io -> https://abc123.ngrok.io/webhook

4. Update GitHub App Settings

  1. Go back to your GitHub App settings.
  2. Update the Webhook URL to point to your deployed application (e.g., https://abc123.ngrok.io/webhook).

5. Install the GitHub App

  1. Go to your GitHub App's settings page.
  2. In the "Install App" section, click "Install App" or "Add Installation".
  3. Choose the account where you want to install the app.
  4. Select the repository (or repositories) where you want to use the app.
  5. Confirm the installation.

Usage

Once installed, the app will automatically:

  1. Monitor new issues and PRs in the selected repositories.
  2. Compare new issues and PRs with existing ones using semantic similarity.
  3. Close and comment on highly similar issues and PRs to reduce duplication.

Configuration

You can adjust the similarity threshold by modifying the SIMILARITY_THRESHOLD variable in the script. The default is set to 0.5.

Troubleshooting

  • Check the server logs for any error messages.
  • Ensure all environment variables are correctly set.
  • Verify that the rsa.pem file is present and correctly formatted.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Star History

Star History Chart