xonecas.io
64875
Mc

mini-coder / commit 26180c9

docs: align release publish instructions and package checks

xonecas2026-04-09 26180c9b5b2d694c49f5894ddcf6f826a247499b parent 176f33a

2 files changed

AGENTS.md+3−3
@@ -38,7 +38,7 @@
3838
3939 - Release instructions live here now; do not rely on `.agents/skills/release`.
4040 - This repo does not have a build step. Do not run `bun run build` for releases.
41-- The published package ships the checked-in Bun launcher (`bin/mc.ts`) and runtime source (`src/index.ts`). The release-time publishability check is `bun pm pack --dry-run --ignore-scripts`.
41+- The published package ships the checked-in Bun launcher (`bin/mc.ts`), runtime source (`src/index.ts`), and `README.md` so npm shows the package docs. The release-time publishability check is `bun pm pack --dry-run --ignore-scripts`.
4242 - Before mutating anything for a release:
4343 - ensure the current branch is `main`
4444 - ensure `git status --porcelain` is empty
@@ -52,7 +52,7 @@
5252 - `bun run check`
5353 - `bun run format`
5454 - `bun run typecheck`
55- - `bun pm pack --dry-run --ignore-scripts`
55+ - `bun pm pack --dry-run --ignore-scripts` and confirm the packed file list includes `README.md`
5656 - Pre-release docs sync:
5757 - audit `README.md` against `spec.md` and the current command/CLI sources (`src/input.ts`, `src/ui/help.ts`, `src/cli.ts`, `src/headless.ts`, `package.json`)
5858 - update `README.md` on `main` first
@@ -66,7 +66,7 @@
6666 - commit with `chore: release v<version>`
6767 - create an annotated tag `v<version>`
6868 - push `main` and the exact tag explicitly
69- - run `npm publish`
69+ - run `npm publish --ignore-scripts`
7070 - verify the publish with `npm view <name>@<version> version`
7171 - If any check fails, stop and report the failure instead of improvising around it.
7272
src/package.test.ts+2−1
@@ -51,12 +51,13 @@ test("package.json declares direct UI types and omits redundant diff typings", a
5151 expect(pkg.devDependencies).not.toHaveProperty("@types/diff");
5252 });
5353
54-test("pack dry-run includes the mc launcher and runtime entrypoint", async () => {
54+test("pack dry-run includes the README, mc launcher, and runtime entrypoint", async () => {
5555 const result = await packDryRun();
5656
5757 expect(result.exitCode).toBe(0);
5858 expect(result.stderr).toBe("");
5959 expect(result.stdout).toContain("packed ");
60+ expect(result.stdout).toContain("README.md");
6061 expect(result.stdout).toContain("bin/mc.ts");
6162 expect(result.stdout).toContain("src/index.ts");
6263 expect(result.stdout).not.toContain("src/package.test.ts");