docs: update changelog for recent merges

[willwashburn]

Summary

• update the Unreleased changelog with recently merged PRs from the last 24 hours
• add migration notes for inbound delivery mode, messaging sender defaults, and telemetry key configuration
• group CLI, broker, SDK, docs, CI, and reliability changes by changelog category

Verification

• git diff --check
• /Users/will/Projects/AgentWorkforce/relay/node_modules/.bin/prettier --check CHANGELOG.md

Note: the isolated worktree did not have its own node_modules install, so the commit hook could not find prettier there; formatting was checked manually with the repo checkout's existing Prettier binary.

[coderabbitai]

📝 Walkthrough

Walkthrough

Updates CHANGELOG.md Unreleased with breaking changes, migration guidance, added/changed/fixed items for delivery modes, CLI/Broker features, messaging/PTY/telemetry/SDK notes; adds a changelog-style guideline to AGENTS.md.

Changes

Unreleased Changelog Updates

Layer / File(s)	Summary
Breaking & migration notes CHANGELOG.md	Documents relay.spawn({ task }) failures returning success: false and terminating the agent after retries, notes agent-relay send defaulting to the orchestrator identity, and adds migration guidance to pass --from when sender identity matters and to set POSTHOG_PROJECT_KEY for telemetry-enabled releases.
Added and Changed items CHANGELOG.md	Expands Added with broker-owned CLI lifecycle commands and attach modes, per-agent delivery-mode/pending/flush routes and TypeScript SDK snapshot/stream/queue inspection/flush support, enhanced worker DM tooling (replies/history, unread/mark-read, sender identity, --since cursors), structured status/log output commands, persona/workforce schema updates, preview cleanup automation, cloud connect helpers, and an SDK workflow script runner; Changed documents inbound delivery-mode naming (auto_inject/manual_flush), SDK-backed CLI attach/sharing behavior, PTY cursor/write routing via FIFO writer, consistent worker timeout/error-envelope shapes, telemetry gating, and inbox unread rendering changes.
Fixes and corrections CHANGELOG.md	Notes fixes: grid-aware readiness detection, history --from ordering preservation, suppressing replies --unread when none unread, clamping negative --limit, improved task delivery retry/cleanup, agent init fixes against stale cache, making better-sqlite3 optional for tests, agent-relay doctor validation fix, and ensuring SDK sendInput reaches agent PTY via PTY worker protocol.
AGENTS changelog style guideline AGENTS.md	Adds a "Changelog Style" section requiring concise, impact-first entries: one short bullet per user-visible change, mention touched command/API/schema and practical effect, and omit links/backstory.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• khaliqgant

Poem

In burrows of changelog light I prance,
I note the modes, the sends, the chance,
A hop for docs and fixes neat,
CLI, inbox, PTY all in beat —
A rabbit cheers the release advance! 🐇

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: updating the changelog to document recently merged pull requests.
Description check	✅ Passed	The description provides a clear summary of changes and verification steps performed, though it omits the formal template sections for 'Test Plan' and 'Screenshots'.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/update-changelog-2026-05-18

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

[cubic-dev-ai]

No issues found across 1 file

_{You’re at about 98% of the monthly reviewed-line limit. You may want to disable incremental reviews to conserve quota. Reviews will continue until that limit is exceeded. If you need help avoiding interruptions, please contact contact@cubic.dev.}

<sub>Tip: cubic could auto-approve low-risk PRs like this, if it thinks it's safe to merge. Learn more

Re-trigger cubic</sub>

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Line 19: The changelog currently references two different env var names
(POSTHOG_PROJECT_KEY and AGENT_RELAY_POSTHOG_KEY); reconcile them by either
standardizing to a single canonical name across the file or adding an explicit
note that POSTHOG_PROJECT_KEY (used in GitHub Actions/release publishing) maps
to AGENT_RELAY_POSTHOG_KEY at runtime, and show the exact mapping example (e.g.,
export AGENT_RELAY_POSTHOG_KEY=$POSTHOG_PROJECT_KEY) so readers won’t set the
wrong variable; update the lines mentioning POSTHOG_PROJECT_KEY and
AGENT_RELAY_POSTHOG_KEY accordingly.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d405fae8-892a-4903-b3af-dd399965e2d4

📥 Commits

Reviewing files that changed from the base of the PR and between 55fda1e and b75f406.

📒 Files selected for processing (2)

• AGENTS.md
• CHANGELOG.md

✅ Files skipped from review due to trivial changes (1)

• AGENTS.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Clarify telemetry key naming to avoid migration misconfiguration.

Line 19 tells users to set POSTHOG_PROJECT_KEY, while Line 53 documents runtime gating on AGENT_RELAY_POSTHOG_KEY. Please reconcile or explicitly explain the mapping so release setup doesn’t use the wrong variable.

Also applies to: 53-53

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CHANGELOG.md` at line 19, The changelog currently references two different
env var names (POSTHOG_PROJECT_KEY and AGENT_RELAY_POSTHOG_KEY); reconcile them
by either standardizing to a single canonical name across the file or adding an
explicit note that POSTHOG_PROJECT_KEY (used in GitHub Actions/release
publishing) maps to AGENT_RELAY_POSTHOG_KEY at runtime, and show the exact
mapping example (e.g., export AGENT_RELAY_POSTHOG_KEY=$POSTHOG_PROJECT_KEY) so
readers won’t set the wrong variable; update the lines mentioning
POSTHOG_PROJECT_KEY and AGENT_RELAY_POSTHOG_KEY accordingly.