sailfork / t3code-github / .repos/ alchemy-effect/ .agents/ skills/ release-blog/ SKILL.md

Write the release blog

The post covers every PR merged to origin/main since the most recent chore(release) commit, and announces the next version. The house rules for release posts live in AGENTS.md ("Blog / Release Notes Conventions"); this skill is the procedure. Read the last two posts in website/src/content/docs/blog/ (*-beta-*.md) before writing. They set the voice, length and structure to match.

1. Collect every PR

.agents/skills/release-blog/scripts/collect-prs.sh /tmp/release-blog-<next>

It prints the release commit (chore(release): 2.0.0-beta.N, so the post is for beta.N+1) and writes one JSON per PR, a digest.txt with every PR's title, author and full body (oldest first), and authors.txt with every non-maintainer author's display name.

2. Read every description in full

Read all of digest.txt, in chunks, start to finish. It holds whole bodies, on purpose: a PR's later sections ("### Changes", a second snippet, a "Removed" list) are where secondary features and renames hide, and a post planned from excerpts folds them into a clause or drops them. Don't sample, and don't skim by title: a chore or test title can carry a user-facing fix, and a feat body often holds the best snippet for the post.

Tag each PR as you go:

  • breaking: ! in the title, or Breaking/[!CAUTION] in the body. Note the migration diff the PR gives. Unmarked PRs break things too: look for "renamed", "removed", "replaces", "is gone", "now requires", "X is now Y" and "was X" in every body. Confirm each one shipped in the last release (git grep <old name> <release-sha> -- packages/) before listing it; a rename of something added in this same release isn't breaking.
  • headline: a dependency upgrade users must make (Effect, a framework major), a new provider or package, a new capability with a user-facing API, or a major bug fix (data loss, wrong resource deleted or taken over, deploys that hang or fail, large perf or bundle wins).
  • also: smaller features and fixes users would notice.
  • skip: internal only. CI, skills, lint and repo tooling, test-only PRs that fix no shipped behavior, distilled bumps without a user-visible change, docs restyles, and fix-ups of earlier PRs in the same release.

Group related PRs into one item: a stack of PRs for one feature is one section, and a family of fixes (drift, ownership, local dev) is one bullet.

3. Plan before writing

Write the plan out first: the title, the breaking-change list, the ordered headline sections with the PRs each one cites, and the also-list groups.

  • Title: 2.0.0-beta.N - <three short items>. It renders in the blog sidebar, so it must fit on one line.
  • Order the headlines by how much they change a user's day: required upgrades (Effect) first, then new providers and packages, then the biggest new capabilities, then major fixes. There is no cap on the number of sections; a large release gets 25–30. Its size is set by what shipped.
  • A new user-facing API gets a snippet, in its own section or in a section about its area (a "New AWS resources and options" section collects smaller ones). Never shrink one into a clause of an unrelated section: a reader skimming headings must find it. A PR that adds several APIs (a store that gains accountId, workerName and domain plus a new bootstrap command) is usually its own section.
  • Everything else goes into ## Also in this release, grouped by area (Cloudflare features, Cloudflare fixes, Local dev fixes, AWS features, AWS fixes, GCP, Domain, Auth, …), each group one bullet with its PR links.

4. Write it

File: website/src/content/docs/blog/YYYY-MM-DD-beta-NN.md, dated the release day (ask if it isn't today). Frontmatter title, date, category: release and a one-sentence excerpt.

  • Open with two short paragraphs naming the headline features in bold.
  • :::caution with Breaking changes at the top. Each item says what to do, with a diff snippet when code changes, and links its section below.
  • One ## per headline. One or two sentences, then a snippet of the user-facing API. Show DX, not implementation: what you write, what you get, the before/after error or output. Take snippets from the PR bodies, trim them, and check the names against the source (grep the export) since PRs get renamed in review.
  • End a section with Docs: [Page](/path) links when a page covers it.
  • Cite PRs inline as ([#NNN](https://github.com/alchemy-run/alchemy/pull/NNN)).
  • Credit external contributors by display name from authors.txt, linked to their GitHub profile: Thanks [Name](https://github.com/login)!. Use the login when there's no display name. PRs a maintainer opened on someone's behalf say so in the body ("carries #N by", "ported from", "supersedes"); credit that person.
  • End with ## Where to go next: doc links, then [CHANGELOG](https://github.com/alchemy-run/alchemy/blob/main/CHANGELOG.md#v200-betaNN) and [Compare v2.0.0-beta.N → v2.0.0-beta.N+1](https://github.com/alchemy-run/alchemy/compare/v2.0.0-beta.N...v2.0.0-beta.N+1).

Format every snippet the way oxfmt would at an 80-column print width (the blog's code column), and move trailing comments that overflow onto their own line. oxfmt reads a top-level yield* as multiplication, so format such snippets by hand or inside a temporary function* () {} wrapper.

Style: plain, direct sentences; no marketing adjectives; no "X just happened" lists explaining a snippet. Every ```diff block needs a context line at column 0 (a comment, an import, the outer call), and +/- lines are the marker followed by the line's real indentation. Inline code that contains a backtick uses double-backtick delimiters.

5. Check it

python3 -I .agents/skills/release-blog/scripts/check-post.py website/src/content/docs/blog/<post>.md /tmp/release-blog-<next>

It checks that every docs link and anchor resolves and that every diff block passes the website build's odd-indent check. Fix every problem it reports. It also lists every feat, fix, perf or ! PR the post doesn't cite. Each one must be a deliberate skip (a fix-up of another PR in this release, test or CI only); cite the rest.

Then hand the post to the user with the headline plan (sections and the PRs behind each), the breaking-change list, and anything you weren't sure about: a PR whose user impact was unclear, a section you cut, or the date. Don't commit, push or open a PR unless asked.

6. Tweets (when asked)

One tweet per major category, in the post's order: Effect, each headline Domain feature, each headline provider feature, state, CLI, and one for the bug fixes. Each tweet is one sentence plus a screenshot of its section.

The sentence states the user-facing change and, when the post has one, its number: "a million accounts in 8 minutes", "plans are 270× faster". Plain words, no hype, no hashtags, no emoji. Take every claim from the post, not from memory.

The screenshot is the section's heading plus its code, diagram or table, with the prose between them hidden. Run the docs dev server (cd website && bunx astro dev --ignore-lock), list each heading's blocks, then write a shots.json that picks them:

PW=$(ls -d node_modules/.pnpm/playwright-core@*/node_modules | tail -1)
URL=http://localhost:4321/blog/<post-slug>/
NODE_PATH=$PW bun .agents/skills/release-blog/scripts/screenshot-sections.mjs $URL --list
NODE_PATH=$PW bun .agents/skills/release-blog/scripts/screenshot-sections.mjs $URL /tmp/tweets-<next> shots.json
{
  "01-effect-41": [["effect-41", "h"], ["effect-41", 1], ["effect-41", 3]],
  "02-domain-rollout": [
    ["deploys-roll-out-every-change-to-a-model", "h"],
    ["how-it-scales", 1],
    ["how-it-scales", 5]
  ]
}

Each entry is [heading id, "h" | n], where n is the block index --list prints under that heading; blocks can come from different headings. Images are dark mode at 2× resolution, and animated figures render their last frame. Pick the block that shows the change best: the diagram over the prose, the failure output over the test code, the before/after table over the setup. Open every image and check that no code line is cut off and no neighbouring text shows.

Show each tweet inline with its image (![](/tmp/tweets-<next>/NN-name.png)), save the text to /tmp/tweets-<next>/tweets.md, and note that no tweet has a link yet. Never post them.