Skip to content

docs(agents): consolidate workflow notes from draft PRs#145

Merged
leoisadev1 merged 1 commit into
mainfrom
posthog-code/agents-md-consolidated
Jul 6, 2026
Merged

docs(agents): consolidate workflow notes from draft PRs#145
leoisadev1 merged 1 commit into
mainfrom
posthog-code/agents-md-consolidated

Conversation

@leoisadev1

Copy link
Copy Markdown
Member

Consolidates the eight overlapping Tembo AGENTS.md drafts (#130, #131, #132, #137, #138, #139, #142, #143) into one coherent update. Every claim was verified against the repo at origin/main (package.json, scripts/, .github/workflows/, packages/email-sdk/test-preload.ts + both bunfig.tomls, packages/convex-email, .changeset/config.json).

What this adds

  • Telemetry section: test isolation via the Bun [test] preload (dual bunfig.toml sync caveat), injected-override pattern for telemetry tests, and user-facing opt-outs.
  • Convex Component section: private package / no changesets, turbo + release:ci + pack:check coverage, build-first requirement for in-package bun test, and the committed schema-derived _generated stubs (codegen needs a live deployment, effectively maintainer-only).
  • Homebrew Formula section: bun run homebrew:update and the automated post-publish automation/homebrew-formula-<version> PR from release.yml.
  • Local Checks: live check scripts are auth-only by default; <PROVIDER>_LIVE_SEND=true sends a real message.
  • Docs Site: bun run types:check validation step and the blog-schedule.yml refresh workflow (VERCEL_DEPLOY_HOOK_URL).
  • CI and Publishing: the non-blocking PostHog release annotation (POSTHOG_PERSONAL_API_KEY).
  • Project: one bullet pointing at the convex-email component.

Per-draft disposition

Draft Verdict Notes
#130 Homebrew Formula section Absorbed All claims verified (homebrew:update script, release.yml automation, branch name).
#131 lint/format + release:ci Dropped Recommends bun run check before every PR, which contradicts this repo's Local Checks rule (repo-wide oxfmt --write reformats ~170 drifted files). Its release:ci correction is already on main in prose form.
#132 Convex component Absorbed (partly) Private-package/changeset rule and schema-derived _generated stubs kept. In-package check commands amended: bun test inside the package needs @opencoredev/email-sdk built first.
#137 Convex component (alt) Absorbed (partly) turbo/release:ci/pack:check coverage kept. Dropped "regenerate and commit _generated after changing convex.config.ts/schema.ts/functions" — the committed stubs are generic and derive types from the schema, and convex codegen needs a configured deployment.
#138 live checks + blog refresh + homebrew bullet Absorbed (partly) blog-schedule.yml paragraph kept (verified against the workflow). Live-check section was mostly redundant with the existing Local Checks block; Homebrew bullet superseded by the dedicated section from #130.
#139 live checks detail + homebrew Absorbed (partly) Auth-only default and <PROVIDER>_LIVE_SEND=true kept (verified in all four scripts/check-*-account.ts). Dropped "they load .env.local then .env" — the scripts only load .env.local. Its Homebrew section omitted the release.yml automation, so #130's version won.
#142 homebrew bullet in CI section Dropped as redundant Accurate but fully covered by the dedicated Homebrew Formula section.
#143 telemetry + docs types:check + release annotation Absorbed All claims verified (preload, dual bunfig, opt-outs incl. telemetry?: boolean client option, fumadocs types:check, annotation step in release.yml).

All eight drafts are closed in favor of this PR.


Created with PostHog Code

Consolidates the accurate, verified additions from Tembo draft PRs #130,
#131, #132, #137, #138, #139, #142, and #143 into one coherent AGENTS.md
update: telemetry test isolation, convex-email component workflow,
Homebrew formula automation, live-check LIVE_SEND behavior, docs-site
types:check, blog refresh workflow, and the PostHog release annotation.

Generated-By: PostHog Code
Task-Id: ec2538f2-5c80-4142-b4b3-b1a53394862e
@cursor

cursor Bot commented Jul 6, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
email-sdk-fumadocs Ready Ready Preview, Comment Jul 6, 2026 6:32pm

Request Review

@greptile-apps

greptile-apps Bot commented Jul 6, 2026

Copy link
Copy Markdown

Greptile Summary

This PR consolidates agent workflow notes in AGENTS.md. The main changes are:

  • Adds guidance for telemetry test isolation and opt-outs.
  • Adds Convex component release, test, and codegen notes.
  • Documents Homebrew formula update flow after npm publishing.
  • Clarifies live provider checks, docs-site validation, blog refresh automation, and PostHog release annotations.

Confidence Score: 5/5

Documentation-only changes are safe to merge once the environment credential guidance is corrected.

The touched file is limited to contributor guidance, and the identified issue is a narrow accuracy problem in the documented credential sources.

AGENTS.md

T-Rex T-Rex Logs

What T-Rex did

  • Telemetry documentation changes were reviewed, confirming that the new Telemetry guidance was added to AGENTS.md and that the preload and telemetry tests pass.
  • Convex documentation updates were reviewed, confirming the new Convex component guidance is present in AGENTS.md and that the package build and tests complete successfully after the dependency steps.
  • Workflow documentation updates were reviewed, confirming the updated AGENTS.md workflow section and script references, with runtime docs commands failing only due to missing dependencies in the checkout.

View all artifacts

T-Rex Ran code and verified through T-Rex

Fix All in Claude Code

Reviews (1): Last reviewed commit: "docs(agents): consolidate workflow notes..." | Re-trigger Greptile

Comment thread AGENTS.md
noise to your diff.

When adding or changing a provider adapter, verify it against a live account. These scripts read provider credentials from `.env.local`:
When adding or changing a provider adapter, verify it against a live account. These scripts read provider credentials from the repo-root `.env.local` (or your shell):

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Keep env guidance accurate
This sentence drops .env, but each listed live-check script calls config({ path: ".env.local" }) and then config(), so missing keys are also loaded from the repo-root .env unless already supplied by .env.local or the shell. Agents following this guidance would miss a supported credential source.

Fix in Claude Code

@leoisadev1 leoisadev1 merged commit 4400f0d into main Jul 6, 2026
4 checks passed
@leoisadev1 leoisadev1 deleted the posthog-code/agents-md-consolidated branch July 6, 2026 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant