mirror of
https://github.com/paperclipai/paperclip
synced 2026-05-08 16:12:20 +02:00
## Thinking Path > - Paperclip is a control plane for autonomous agent companies, so its release automation is part of the core operator trust boundary. > - The affected subsystem is npm/GitHub Actions release publishing for the public monorepo packages. > - The concrete failure was that a newly added package reached `master`, the canary workflow attempted its first publish, and npm trusted publishing was not yet bootstrapped for that package. > - That means the problem is not just one broken run; it is a missing pre-merge guard that lets release-ineligible packages land and only fail once `publish_canary` runs. > - This pull request makes release enrollment explicit, validates that enrollment in CI, and adds a PR-time bootstrap check against npm for changed release-enabled package manifests. > - The result is that we keep trusted publishing, avoid teaching CI to `npm adduser`, and move this class of failure from post-merge canary time to pre-merge review time. ## What Changed - Added `scripts/release-package-manifest.json` so release-managed public packages are explicitly enrolled instead of being inferred from every non-private workspace package. - Hardened `scripts/release-package-map.mjs` to validate the manifest before release workflows rewrite versions or assemble publish payloads. - Added `scripts/check-release-package-bootstrap.mjs` and wired it into `.github/workflows/pr.yml` so PRs that change a release-enabled package manifest fail if that package does not already exist on npm. - Added release-package manifest coverage tests to `scripts/release-package-map.test.mjs` and included them in `pnpm run test:release-registry`. - Wired manifest validation into `.github/workflows/release.yml` and documented the first-publish bootstrap policy in `doc/PUBLISHING.md` and `doc/RELEASE-AUTOMATION-SETUP.md`. ## Verification - `pnpm run test:release-registry` - `./scripts/release.sh canary --skip-verify --dry-run` - Confirmed the committed diff contains no obvious PII/secrets via targeted pattern scan before pushing. ## Risks - Low risk overall: this is CI/release-policy code, not product runtime logic. - The new PR bootstrap check depends on npm metadata availability, so a transient npm outage could block a PR that changes a release-enabled package manifest. - The manifest introduces a new source of truth that must stay aligned with public package additions, but that is intentional and now enforced. ## Model Used - OpenAI Codex via the `codex_local` Paperclip adapter; GPT-5-based coding agent with tool use, terminal execution, git, and GitHub CLI. Exact served model ID/context window are not exposed by the local runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge
286 lines
7.5 KiB
JavaScript
286 lines
7.5 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import { readdirSync, readFileSync, writeFileSync, existsSync } from "node:fs";
|
|
import { fileURLToPath } from "node:url";
|
|
import { dirname, join, resolve } from "node:path";
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = resolve(__dirname, "..");
|
|
const manifestPath = join(repoRoot, "scripts", "release-package-manifest.json");
|
|
const roots = ["packages", "server", "ui", "cli"];
|
|
|
|
function readJson(filePath) {
|
|
return JSON.parse(readFileSync(filePath, "utf8"));
|
|
}
|
|
|
|
function discoverPublicPackages() {
|
|
const packages = [];
|
|
|
|
function walk(relDir) {
|
|
const absDir = join(repoRoot, relDir);
|
|
if (!existsSync(absDir)) return;
|
|
|
|
const pkgPath = join(absDir, "package.json");
|
|
if (existsSync(pkgPath)) {
|
|
const pkg = readJson(pkgPath);
|
|
if (!pkg.private) {
|
|
packages.push({
|
|
dir: relDir,
|
|
pkgPath,
|
|
name: pkg.name,
|
|
version: pkg.version,
|
|
pkg,
|
|
});
|
|
}
|
|
return;
|
|
}
|
|
|
|
for (const entry of readdirSync(absDir, { withFileTypes: true })) {
|
|
if (!entry.isDirectory()) continue;
|
|
if (entry.name === "node_modules" || entry.name === "dist" || entry.name === ".git") continue;
|
|
walk(join(relDir, entry.name));
|
|
}
|
|
}
|
|
|
|
for (const rel of roots) {
|
|
walk(rel);
|
|
}
|
|
|
|
return packages;
|
|
}
|
|
|
|
function loadReleaseManifest() {
|
|
const manifest = readJson(manifestPath);
|
|
|
|
if (!Array.isArray(manifest)) {
|
|
throw new Error(`expected ${manifestPath} to contain an array.`);
|
|
}
|
|
|
|
return manifest.map((entry, index) => {
|
|
if (!entry || typeof entry !== "object" || Array.isArray(entry)) {
|
|
throw new Error(`manifest entry ${index + 1} in ${manifestPath} must be an object.`);
|
|
}
|
|
|
|
if (typeof entry.dir !== "string" || entry.dir.length === 0) {
|
|
throw new Error(`manifest entry ${index + 1} in ${manifestPath} is missing a non-empty "dir".`);
|
|
}
|
|
|
|
if (typeof entry.name !== "string" || entry.name.length === 0) {
|
|
throw new Error(`manifest entry ${index + 1} in ${manifestPath} is missing a non-empty "name".`);
|
|
}
|
|
|
|
if (typeof entry.publishFromCi !== "boolean") {
|
|
throw new Error(
|
|
`manifest entry ${index + 1} (${entry.dir}) in ${manifestPath} must set boolean "publishFromCi".`,
|
|
);
|
|
}
|
|
|
|
return entry;
|
|
});
|
|
}
|
|
|
|
function buildReleasePackagePlan() {
|
|
const discoveredPackages = discoverPublicPackages();
|
|
const manifestEntries = loadReleaseManifest();
|
|
const packageByDir = new Map(discoveredPackages.map((pkg) => [pkg.dir, pkg]));
|
|
const manifestByDir = new Map();
|
|
const problems = [];
|
|
|
|
for (const entry of manifestEntries) {
|
|
if (manifestByDir.has(entry.dir)) {
|
|
problems.push(`duplicate manifest entry for ${entry.dir}`);
|
|
continue;
|
|
}
|
|
|
|
manifestByDir.set(entry.dir, entry);
|
|
const pkg = packageByDir.get(entry.dir);
|
|
|
|
if (!pkg) {
|
|
problems.push(`${entry.dir} is listed in ${manifestPath} but is not a public package in this repo`);
|
|
continue;
|
|
}
|
|
|
|
if (pkg.name !== entry.name) {
|
|
problems.push(
|
|
`${entry.dir} is listed as ${entry.name} in ${manifestPath}, but package.json declares ${pkg.name}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
for (const pkg of discoveredPackages) {
|
|
if (!manifestByDir.has(pkg.dir)) {
|
|
problems.push(
|
|
`${pkg.dir} (${pkg.name}) is public but missing from ${manifestPath}; add it with publishFromCi true or false`,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (problems.length > 0) {
|
|
throw new Error(`release package manifest validation failed:\n- ${problems.join("\n- ")}`);
|
|
}
|
|
|
|
const packages = discoveredPackages.map((pkg) => ({
|
|
...pkg,
|
|
publishFromCi: manifestByDir.get(pkg.dir).publishFromCi,
|
|
}));
|
|
|
|
return packages;
|
|
}
|
|
|
|
function sortTopologically(packages) {
|
|
const byName = new Map(packages.map((pkg) => [pkg.name, pkg]));
|
|
const visited = new Set();
|
|
const visiting = new Set();
|
|
const ordered = [];
|
|
|
|
function visit(pkg) {
|
|
if (visited.has(pkg.name)) return;
|
|
if (visiting.has(pkg.name)) {
|
|
throw new Error(`cycle detected in release package graph at ${pkg.name}`);
|
|
}
|
|
|
|
visiting.add(pkg.name);
|
|
|
|
const dependencySections = [
|
|
pkg.pkg.dependencies ?? {},
|
|
pkg.pkg.optionalDependencies ?? {},
|
|
pkg.pkg.peerDependencies ?? {},
|
|
];
|
|
|
|
for (const deps of dependencySections) {
|
|
for (const depName of Object.keys(deps)) {
|
|
const dep = byName.get(depName);
|
|
if (dep) visit(dep);
|
|
}
|
|
}
|
|
|
|
visiting.delete(pkg.name);
|
|
visited.add(pkg.name);
|
|
ordered.push(pkg);
|
|
}
|
|
|
|
for (const pkg of [...packages].sort((a, b) => a.dir.localeCompare(b.dir))) {
|
|
visit(pkg);
|
|
}
|
|
|
|
return ordered;
|
|
}
|
|
|
|
function getReleasePackages() {
|
|
return sortTopologically(buildReleasePackagePlan().filter((pkg) => pkg.publishFromCi));
|
|
}
|
|
|
|
function replaceWorkspaceDeps(deps, version) {
|
|
if (!deps) return deps;
|
|
const next = { ...deps };
|
|
|
|
for (const [name, value] of Object.entries(next)) {
|
|
if (!name.startsWith("@paperclipai/")) continue;
|
|
if (typeof value !== "string" || !value.startsWith("workspace:")) continue;
|
|
next[name] = version;
|
|
}
|
|
|
|
return next;
|
|
}
|
|
|
|
function setVersion(version) {
|
|
const packages = getReleasePackages();
|
|
|
|
for (const pkg of packages) {
|
|
const nextPkg = {
|
|
...pkg.pkg,
|
|
version,
|
|
dependencies: replaceWorkspaceDeps(pkg.pkg.dependencies, version),
|
|
optionalDependencies: replaceWorkspaceDeps(pkg.pkg.optionalDependencies, version),
|
|
peerDependencies: replaceWorkspaceDeps(pkg.pkg.peerDependencies, version),
|
|
devDependencies: replaceWorkspaceDeps(pkg.pkg.devDependencies, version),
|
|
};
|
|
|
|
writeFileSync(pkg.pkgPath, `${JSON.stringify(nextPkg, null, 2)}\n`);
|
|
}
|
|
|
|
const cliEntryPath = join(repoRoot, "cli/src/index.ts");
|
|
const cliEntry = readFileSync(cliEntryPath, "utf8");
|
|
const nextCliEntry = cliEntry.replace(
|
|
/\.version\("([^"]+)"\)/,
|
|
`.version("${version}")`,
|
|
);
|
|
|
|
if (cliEntry !== nextCliEntry) {
|
|
writeFileSync(cliEntryPath, nextCliEntry);
|
|
return;
|
|
}
|
|
|
|
if (!cliEntry.includes(".version(cliVersion)")) {
|
|
throw new Error("failed to rewrite CLI version string in cli/src/index.ts");
|
|
}
|
|
}
|
|
|
|
function listPackages() {
|
|
const packages = getReleasePackages();
|
|
for (const pkg of packages) {
|
|
process.stdout.write(`${pkg.dir}\t${pkg.name}\t${pkg.version}\n`);
|
|
}
|
|
}
|
|
|
|
function checkConfiguration() {
|
|
const packages = buildReleasePackagePlan();
|
|
const enabledCount = packages.filter((pkg) => pkg.publishFromCi).length;
|
|
const disabledCount = packages.length - enabledCount;
|
|
|
|
if (enabledCount === 0) {
|
|
throw new Error(`no packages are enabled for CI publishing in ${manifestPath}`);
|
|
}
|
|
|
|
process.stdout.write(
|
|
`Release package manifest OK: ${enabledCount} enabled for CI publish, ${disabledCount} disabled pending bootstrap.\n`,
|
|
);
|
|
}
|
|
|
|
function usage() {
|
|
process.stderr.write(
|
|
[
|
|
"Usage:",
|
|
" node scripts/release-package-map.mjs list",
|
|
" node scripts/release-package-map.mjs check",
|
|
" node scripts/release-package-map.mjs set-version <version>",
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
}
|
|
|
|
const [command, arg] = process.argv.slice(2);
|
|
const isDirectRun = process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url);
|
|
|
|
if (isDirectRun) {
|
|
if (command === "list") {
|
|
listPackages();
|
|
process.exit(0);
|
|
}
|
|
|
|
if (command === "check") {
|
|
checkConfiguration();
|
|
process.exit(0);
|
|
}
|
|
|
|
if (command === "set-version") {
|
|
if (!arg) {
|
|
usage();
|
|
process.exit(1);
|
|
}
|
|
setVersion(arg);
|
|
process.exit(0);
|
|
}
|
|
|
|
usage();
|
|
process.exit(1);
|
|
}
|
|
|
|
export {
|
|
buildReleasePackagePlan,
|
|
checkConfiguration,
|
|
discoverPublicPackages,
|
|
getReleasePackages,
|
|
loadReleaseManifest,
|
|
};
|