# GitHub Digest

A scheduled pull request briefing workspace. Every Monday and Thursday at 8:30am Pacific, it scans GitHub for your open PRs and pending review requests, and surfaces a clean digest — no dashboard to open, no GitHub inbox to scan.

The digest is organized into three sections:

- **Your Open PRs** — title, repo, URL, age, and current review status (approved / changes requested / awaiting)
- **Review Requested** — PRs where you're asked to review, with title, repo, URL, and author
- **Summary** — one sentence on total counts and any urgent items

---

![github-digest output](https://raw.githubusercontent.com/friday-platform/friday-studio-examples/main/assets/github-digest/output.png)

---

## Setup

### 1. Download Friday

1. Go to [hellofriday.ai](https://hellofriday.ai) and download the macOS installer
2. Open the DMG and drag Friday to your Applications folder
3. Launch Friday and complete the initial setup

### 2. Import the workspace

1. Open Friday and go to **Discover Spaces**
2. Find this workspace and click it
3. Click **Add Space**

### 3. Connect GitHub

GitHub Digest uses the GitHub MCP server, which needs a personal access token to query your PRs and review requests.

**Generate a token**

1. Go to [github.com/settings/tokens](https://github.com/settings/tokens)
2. Click **Generate new token (classic)**
3. Give it a name (e.g. `friday-digest`)
4. Select the following scopes:
   - `repo` — to read pull requests across your repos
   - `read:user` — to resolve your GitHub username automatically
5. Click **Generate token** and copy it — you won't see it again

**Connect it in Friday**

1. Open the imported workspace and start a chat
2. Friday will detect that GitHub needs credentials and surface a **Connect GitHub** prompt
3. Paste your token when asked
4. You're connected — no further setup needed

### 4. That's it

No email recipient to configure, no additional MCP servers to enable. The digest runs against your authenticated GitHub account and outputs directly to the workspace session.

---

## What the digest looks like

> **Your Open PRs**
>
> - [Fix auth token refresh](https://github.com/...) — `my-org/api` — 3 days old — awaiting review
>
> **Review Requested**
>
> - [Add rate limiting middleware](https://github.com/...) — `my-org/api` — by @colleague
>
> **Summary**
> 1 open PR, 1 review pending. No urgent items.

---

## How to use it

It runs automatically. Nothing to trigger, nothing to open.

The digest fires every **Monday and Thursday at 8:30am Pacific** (cron: `30 8 * * 1,4` in `America/Los_Angeles`).

---

## How it works

![github-digest workspace overview in Friday](https://raw.githubusercontent.com/friday-platform/friday-studio-examples/main/assets/github-digest/how-it-works.png)

| Component | Role |
|---|---|
| `github-digest-agent` | LLM agent (Claude Opus) that queries GitHub for your open PRs and review requests, then formats a Markdown digest |
| `github-digest-job` | Three-state FSM: idle → run agent → done |
| `github-digest-schedule` | Schedule signal firing at `30 8 * * 1,4` in `America/Los_Angeles` (8:30am Pacific, Monday and Thursday) |
| `github` MCP server | Provides `get_me`, `search_pull_requests`, and `pull_request_read` tools |

The schedule fires the `github-digest-schedule` signal, which starts the `github-digest-job` FSM. The FSM runs `github-digest-agent` in a single step, which calls GitHub MCP tools in sequence — get the authenticated user, search authored PRs, search review-requested PRs — then renders the digest and stores it in `digest-result`.

---

## Notes

- The agent calls `get_me` first to resolve your GitHub login dynamically — no hardcoded username required.
- If a section is empty (no open PRs, no review requests), the agent says so explicitly rather than omitting it.
- The schedule is configured in `America/Los_Angeles` so it fires at 8:30am Pacific year-round, automatically adjusting for daylight saving time. To change it, edit the `timezone` and `schedule` fields under `signals.github-digest-schedule.config` in `workspace.yml`.
- All data stays within your Friday workspace and GitHub OAuth session.