A LLM powered github end-of-day bot powered by Haystack and OpenAI
This GitHub bot crawls your GitHub activity on a selected day, groups the events by action (push, pull request, issue, etc.), and sends you a summary of your activity in natural language. This message can be used as an EOD (End of Day) report in your Slack channel.
This bot should help me close my laptop and be happy about the work I've done that day. Hopefully, it will help you too.
⚠️ Please be careful with sensitive data: You might be working on a project that contains sensitive data that should not leave your company. Please make sure what you are sending to OpenAI before running this bot!
This example of a haystack promptnode uses two templates to generate a summary of actions. The first template is used to generate a summary per event type from github. The second template is used to generate the final summary of all events.
The challenging part was to make GPT 'hallucinate' just the right amount to connect the dots but not make up facts. The bot is not perfect and will make mistakes. The most common issue I saw in my tests was that the bot lists irrelevant events/actions like Pushed something to main. There is still some room for improvement for the prompt templates.
- Clone this repository
- Install the dependencies with
pip3 install -r requirements.txt. This installs haystack and some other required packages to fetch the data from github. - Create a new github access token.
- Create a OpenAI API key.
Run the bot with
GH_ACCESS_TOKEN=<your-token> OPENAI_KEY=<openai-key> python3 main.py