Closes the user's gap: when `pnpm turbo gen feature <name>` scaffolds
a new feature, that feature must also be tracked by release-please —
otherwise it sits outside the versioning + changelog pipeline.
The generator now performs three release-please integrations:
1. **CHANGELOG.md seeded at v0.1.0** — new template at
templates/feature/CHANGELOG.md.hbs emits a baseline entry pointing
at ADR-021 + docs/guides/releasing.md so the consumer immediately
sees where future entries will appear.
2. **package.json version field bumped** — templates/feature/
package.json.hbs: "0.0.0" -> "0.1.0", matching the per-feature
baseline established when release-please was set up.
3. **Manifest + config registration via a new custom action** —
lib/release-please-utils.ts exports
registerFeatureInReleasePlease(repoRoot, name) which:
- Reads .release-please-manifest.json, adds
`"packages/<name>": "0.1.0"`, writes back with sorted keys
(root stays first, rest alphabetical) so diffs stay minimal
- Reads release-please-config.json, adds the per-package config
block (package-name, component, changelog-path), writes back
with the same sort
- Idempotent — re-running on an already-tracked feature is a
no-op
- Throws fast if either file is missing (ADR-021 requires
release-please to be set up BEFORE features can register)
The generator wires this in via a function action between the last
file `add` and the next-steps printout. Its return string surfaces
in the generator log so the user sees "Registered @repo/<name> in
release-please tracking".
Tested: 5/5 unit tests cover the happy path, idempotency, sort
order, and both missing-file error paths. Smoke-tested against the
real repo configs (adding a synthetic "demo" feature, then
restoring) — manifest entry appears in the correct sorted position;
config block has the right shape.
Future `pnpm turbo gen feature` invocations cannot leave a feature
untracked. Existing features (auth, blog, media, marketing-pages,
navigation) were registered manually when the release-please epic
landed.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
147 lines
4.3 KiB
JavaScript
147 lines
4.3 KiB
JavaScript
import { test, describe } from "node:test";
|
|
import assert from "node:assert/strict";
|
|
import fs from "node:fs";
|
|
import path from "node:path";
|
|
import os from "node:os";
|
|
import { registerFeatureInReleasePlease } from "./release-please-utils.ts";
|
|
|
|
function setupRepo() {
|
|
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), "rp-utils-"));
|
|
fs.writeFileSync(
|
|
path.join(tmp, ".release-please-manifest.json"),
|
|
JSON.stringify(
|
|
{
|
|
".": "0.1.0",
|
|
"packages/auth": "0.1.0",
|
|
"packages/blog": "0.1.0",
|
|
},
|
|
null,
|
|
2,
|
|
) + "\n",
|
|
);
|
|
fs.writeFileSync(
|
|
path.join(tmp, "release-please-config.json"),
|
|
JSON.stringify(
|
|
{
|
|
"release-type": "node",
|
|
"include-component-in-tag": true,
|
|
packages: {
|
|
".": {
|
|
"package-name": "template-vertical",
|
|
component: "template",
|
|
"changelog-path": "CHANGELOG.md",
|
|
},
|
|
"packages/auth": {
|
|
"package-name": "@repo/auth",
|
|
component: "auth",
|
|
"changelog-path": "CHANGELOG.md",
|
|
},
|
|
},
|
|
},
|
|
null,
|
|
2,
|
|
) + "\n",
|
|
);
|
|
return tmp;
|
|
}
|
|
|
|
describe("registerFeatureInReleasePlease", () => {
|
|
test("adds a new package to both files", () => {
|
|
const tmp = setupRepo();
|
|
try {
|
|
const { manifestChanged, configChanged } = registerFeatureInReleasePlease(
|
|
tmp,
|
|
"comments",
|
|
);
|
|
assert.equal(manifestChanged, true);
|
|
assert.equal(configChanged, true);
|
|
|
|
const manifest = JSON.parse(
|
|
fs.readFileSync(
|
|
path.join(tmp, ".release-please-manifest.json"),
|
|
"utf8",
|
|
),
|
|
);
|
|
assert.equal(manifest["packages/comments"], "0.1.0");
|
|
|
|
const config = JSON.parse(
|
|
fs.readFileSync(path.join(tmp, "release-please-config.json"), "utf8"),
|
|
);
|
|
assert.deepEqual(config.packages["packages/comments"], {
|
|
"package-name": "@repo/comments",
|
|
component: "comments",
|
|
"changelog-path": "CHANGELOG.md",
|
|
});
|
|
} finally {
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("is idempotent — re-running on an already-tracked feature is a no-op", () => {
|
|
const tmp = setupRepo();
|
|
try {
|
|
const first = registerFeatureInReleasePlease(tmp, "comments");
|
|
assert.equal(first.manifestChanged, true);
|
|
const second = registerFeatureInReleasePlease(tmp, "comments");
|
|
assert.equal(second.manifestChanged, false);
|
|
assert.equal(second.configChanged, false);
|
|
} finally {
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("keeps root ('.') entry first and sorts the rest alphabetically", () => {
|
|
const tmp = setupRepo();
|
|
try {
|
|
registerFeatureInReleasePlease(tmp, "alphabetically-first-comments");
|
|
|
|
const manifestText = fs.readFileSync(
|
|
path.join(tmp, ".release-please-manifest.json"),
|
|
"utf8",
|
|
);
|
|
const keys = Object.keys(JSON.parse(manifestText));
|
|
assert.equal(keys[0], ".", "root should always be first");
|
|
// The rest are alphabetical
|
|
const rest = keys.slice(1);
|
|
const sorted = [...rest].sort();
|
|
assert.deepEqual(rest, sorted);
|
|
|
|
const configText = fs.readFileSync(
|
|
path.join(tmp, "release-please-config.json"),
|
|
"utf8",
|
|
);
|
|
const packageKeys = Object.keys(JSON.parse(configText).packages);
|
|
assert.equal(packageKeys[0], ".");
|
|
assert.deepEqual(packageKeys.slice(1), [...packageKeys.slice(1)].sort());
|
|
} finally {
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("throws if .release-please-manifest.json is missing", () => {
|
|
const tmp = setupRepo();
|
|
try {
|
|
fs.unlinkSync(path.join(tmp, ".release-please-manifest.json"));
|
|
assert.throws(
|
|
() => registerFeatureInReleasePlease(tmp, "x"),
|
|
/\.release-please-manifest\.json is missing/,
|
|
);
|
|
} finally {
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("throws if release-please-config.json is missing", () => {
|
|
const tmp = setupRepo();
|
|
try {
|
|
fs.unlinkSync(path.join(tmp, "release-please-config.json"));
|
|
assert.throws(
|
|
() => registerFeatureInReleasePlease(tmp, "x"),
|
|
/release-please-config\.json is missing/,
|
|
);
|
|
} finally {
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|