Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joecorall/retro
Help summarize what you did this week
https://github.com/joecorall/retro
github-api go openai-api
Last synced: 8 days ago
JSON representation
Help summarize what you did this week
- Host: GitHub
- URL: https://github.com/joecorall/retro
- Owner: joecorall
- Created: 2024-04-25T06:45:00.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-16T10:02:09.000Z (6 months ago)
- Last Synced: 2024-05-17T10:56:04.502Z (6 months ago)
- Topics: github-api, go, openai-api
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# retro
Help summarize what you did this week
## Why?
If you struggle to prepare for team reviews/syncs with a list of what you did last week, this service may be able to help.
## What?
Searches GitHub for your commit and PR history over the past week.
Sends the commit message, PR title, and PR message to ChatGPT asking it to summarize.
If a `SLACK_WEBHOOK_URL` environment variable is set, sends the summary to a slack webhook URL. Otherwise prints the summary to stdout.
### Environment Variables
| Env Var Name | Explanation |
|------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GITHUB_TOKEN` | Your GitHub token so you can read commmits and PRs from private repos |
| `GITHUB_ACTOR` | Your GitHub username |
| `OPENAI_API_KEY` | Your OpenAI API Key that can write to `/v1/chat/completions` |
| `SLACK_WEBHOOK_URL`| (optional) Your summary will be sent to this URL using [a mrkdwn block section](https://api.slack.com/messaging/webhooks#advanced_message_formatting) |
| `IGNORE_ORGS` | (optional) comma separated list of GITHUB_ORGS to not include in summary |