Skip to content

Commit bc6738f

Browse files
authored
Create README.md
1 parent 8939b1b commit bc6738f

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# 🐛 models-discussion-watcher
2+
3+
This GitHub Action monitors the public [GitHub Models Community Discussions](https://github.com/orgs/community/discussions/categories/models) and uses **GitHub Models AI** to detect posts that may contain bug reports. If a potential bug is found, the Action automatically opens a GitHub Issue for the team to triage.
4+
5+
---
6+
7+
## 🔍 What it does
8+
9+
* Scrapes the **Models** category in GitHub Discussions
10+
* Uses `openai/gpt-4o` via [GitHub Models](https://docs.github.com/en/rest/models?apiVersion=2022-11-28) to classify each post as:
11+
12+
* `BUG_REPORT`
13+
* `FEATURE_REQUEST`
14+
* `QUESTION`
15+
* `DISCUSSION`
16+
* Adds a confidence score and brief reasoning for each classification
17+
* Automatically creates GitHub Issues for high-confidence bug reports
18+
19+
---
20+
21+
## 🧠 Why this matters
22+
23+
If a bug report comes in via the community forum, I want to know right away. This Action helps surface those issues automatically—without waiting for someone to manually triage.
24+
25+
It’s also a sample workflow that shows how GitHub Models can streamline your team's processes with a bit of automation and AI! ✨
26+
27+
---
28+
29+
## 🛠 How it works
30+
31+
* **Runs daily at 4PM UTC**
32+
* Only processes new discussions posted in the past 24 hours (no duplicates)
33+
* Falls back to a keyword-based classifier if the API call fails
34+
* Issues are labeled `auto-detected`, `bug-report`, and `needs-triage`
35+
36+
---
37+
38+
## 🚀 Usage
39+
40+
1. Fork or clone the repo
41+
2. Customize the discussion category, model used, or classification logic as needed
42+
3. Enable or modify the schedule in `.github/workflows/main.yml`
43+
4. That’s it!
44+
45+
---
46+
47+
## 🧪 Example Output
48+
49+
```
50+
📊 SUMMARY (Last 24 Hours)
51+
🐛 Bug Reports: 2
52+
✨ Feature Requests: 1
53+
❓ Questions: 3
54+
💬 General Discussions: 4
55+
56+
🐛 BUG REPORTS DETECTED
57+
• Embedding API only returns one result when I send multiple inputs? (92% confidence)
58+
💭 This suggests the user expected batch support but got a single result.
59+
🔗 https://github.com/orgs/community/discussions/...
60+
61+
✅ GitHub Issue #42 created for triage.
62+
```
63+
64+
---
65+
66+
## 🙋‍♀️ Why I built this
67+
68+
Sometimes the best bug reports come from the community just talking about what's going on. This was a fun experiment to combine GitHub Actions + GitHub Models to automatically catch them upstream.
69+
70+
I also want people to feel empowered to sprinkle AI into their own workflows—effortlessly. This project shows how you can do that with almost no extra setup, just by using Actions and the Models API.
71+
72+
PRs welcome, ideas encouraged!

0 commit comments

Comments
 (0)