diff --git a/docs/release.md b/docs/release.md index 9277b99d..b5f22722 100644 --- a/docs/release.md +++ b/docs/release.md @@ -20,7 +20,7 @@ jj git push --remote origin --bookmark main git push origin X.Y.Z ``` -`release:prepare` updates the version files and creates a `## Changes` release notes template. `release:preflight` verifies the local Jujutsu/Git state, release metadata, lockfile, and the same non-cached `npm run check:ci` validation used by CI after the release commit is on `main`. +`release:prepare` updates the version files and creates a `## Changes` release notes template. `release:preflight` verifies the local Jujutsu/Git state, release metadata, API baselines, lockfile, and the same non-cached `npm run check:ci` validation used by CI after the release commit is on `main`. Release notes should normally include only user-facing changes. Internal implementation changes, validation details, and release procedure notes should be omitted when minor; when they are important enough to mention, group them into at most one concise bullet. diff --git a/scripts/release/preflight.mjs b/scripts/release/preflight.mjs index f72d3bd8..d0fe4ce3 100644 --- a/scripts/release/preflight.mjs +++ b/scripts/release/preflight.mjs @@ -86,6 +86,7 @@ if (maybeRun("jj", ["root"])) { } run("npm", ["run", "release:check"]); +run("npm", ["run", "api:baseline"]); run("npm", ["ci", "--dry-run"]); run("npm", ["run", "check:ci"]);