feat: Add auto-PR description action

[nwthomas]

Problem

There was no automated mechanism to generate pull request descriptions based on the code changes, commit messages, and context from the existing files in the repository.

Solution

This pull request introduces an automation workflow that automatically generates detailed pull request descriptions using GitHub Actions and OpenAI's language model capabilities.

The key changes include:

1. Pull Request Template: Added a markdown template for pull request descriptions.
2. GitHub Workflow: Created a GitHub Actions workflow that triggers on pull request events (opened and synchronize). This workflow:
   • Checks out the repository.
   • Sets up a Python environment.
   • Installs necessary dependencies.
   • Fetches pull request information.
   • Generates a detailed pull request description using the OpenAI model.
   • Updates the pull request description.
3. Python Script: Added a Python script (main.py) to handle the logic for generating the pull request description. This script:
   • Fetches the pull request data and diffs.
   • Embeds the repository documents using Pinecone.
   • Searches embeddings to retrieve context.
   • Formats the data into a prompt.
   • Calls the OpenAI model to generate the description.
   • Updates the pull request with the new description.
4. Dependencies and Setup: Added necessary dependencies in requirements.txt and a setup configuration in setup.py.
5. Git Ignore: Updated the .gitignore file to exclude unnecessary files and directories.
6. License: Added the MIT License file.

Testing

• The workflow was tested to ensure that it correctly triggers on pull request events and generates the appropriate descriptions.
• The Python script was tested to ensure it properly interacts with the GitHub API, embeds documents, formats the prompt, and integrates with the OpenAI model.
• Verified that the generated pull request descriptions follow the template format and include relevant context.

Reverting

• To revert, the workflow can be disabled or deleted from the repository.
• Any additional artifacts or configurations added can be removed to restore the repository to its previous state.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
personal-portfolio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 20, 2024 5:53am