Skip to content

docs(agents): document live account checks and homebrew:update #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tembo wants to merge 1 commit into from
Closed

docs(agents): document live account checks and homebrew:update #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,40 @@ bun run build
packages/email-sdk/dist/cli.js adapters
```

## Live Provider Account Checks

`scripts/check-<provider>-account.ts` verify that provider credentials
authenticate against the real API, useful before shipping an adapter change.
They load `.env.local` then `.env`, and by default only probe the auth path (no
email is sent). Set `<PROVIDER>_LIVE_SEND=true` (plus the provider's from/to env
vars) to actually send a live test message.

Two have `bun run` aliases:

```bash
bun run live:sequenzy
bun run live:lettermint
```

Run the others directly:

```bash
bun scripts/check-jetemail-account.ts
bun scripts/check-primitive-account.ts
```

## Homebrew Formula

`Formula/email-sdk.rb` is refreshed after a release with:

```bash
bun run homebrew:update
```

It reads the current `packages/email-sdk` version, resolves the published npm
tarball's `sha256`, and rewrites the formula's `url` and `sha256`. Run it once
the version is live on npm.

## Major Versions

Major versions need migration notes in the PR that introduces the breaking change. Include before/after examples for changed imports, options, CLI flags, adapter behavior, or public types.
Expand Down