mirror of
https://github.com/paperclipai/paperclip
synced 2026-05-12 09:56:40 +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
295 lines
8.0 KiB
JavaScript
295 lines
8.0 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import { spawnSync } from "node:child_process";
|
|
import { fileURLToPath } from "node:url";
|
|
import { dirname, join, resolve } from "node:path";
|
|
|
|
import { buildReleasePackagePlan } from "./release-package-map.mjs";
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = resolve(__dirname, "..");
|
|
|
|
function normalizePath(filePath) {
|
|
return filePath.replace(/\\/g, "/").replace(/^\.\//, "");
|
|
}
|
|
|
|
function usage() {
|
|
process.stderr.write(
|
|
[
|
|
"Usage:",
|
|
" node scripts/bootstrap-npm-package.mjs <package-name-or-dir> [--publish --otp <code>] [--skip-build]",
|
|
"",
|
|
"Examples:",
|
|
" node scripts/bootstrap-npm-package.mjs @paperclipai/adapter-acpx-local",
|
|
" node scripts/bootstrap-npm-package.mjs packages/adapters/acpx-local --publish",
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
}
|
|
|
|
function parseArgs(argv) {
|
|
const flags = new Set();
|
|
let selector = null;
|
|
let otp = null;
|
|
|
|
for (let index = 0; index < argv.length; index += 1) {
|
|
const arg = argv[index];
|
|
if (arg === "--") {
|
|
continue;
|
|
}
|
|
|
|
if (arg === "--publish" || arg === "--skip-build") {
|
|
flags.add(arg);
|
|
continue;
|
|
}
|
|
|
|
if (arg === "--otp") {
|
|
const value = argv[index + 1];
|
|
if (!value || value.startsWith("--")) {
|
|
throw new Error("expected a one-time password after --otp");
|
|
}
|
|
otp = value;
|
|
index += 1;
|
|
continue;
|
|
}
|
|
|
|
if (arg === "--help" || arg === "-h") {
|
|
return { help: true, selector: null, publish: false, skipBuild: false, otp: null };
|
|
}
|
|
|
|
if (arg.startsWith("--")) {
|
|
throw new Error(`unknown option: ${arg}`);
|
|
}
|
|
|
|
if (selector) {
|
|
throw new Error("expected exactly one package selector");
|
|
}
|
|
|
|
selector = arg;
|
|
}
|
|
|
|
return {
|
|
help: false,
|
|
selector,
|
|
publish: flags.has("--publish"),
|
|
skipBuild: flags.has("--skip-build"),
|
|
otp,
|
|
};
|
|
}
|
|
|
|
function runCommand(command, args, options = {}) {
|
|
const result = spawnSync(command, args, {
|
|
cwd: repoRoot,
|
|
encoding: "utf8",
|
|
stdio: ["inherit", "pipe", "pipe"],
|
|
...options,
|
|
});
|
|
|
|
if (result.error) {
|
|
throw result.error;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
function runChecked(command, args, options = {}) {
|
|
const result = runCommand(command, args, options);
|
|
const stdout = result.stdout ?? "";
|
|
const stderr = result.stderr ?? "";
|
|
|
|
if (stdout) process.stdout.write(stdout);
|
|
if (stderr) process.stderr.write(stderr);
|
|
|
|
if (result.status !== 0) {
|
|
throw new Error(`${command} ${args.join(" ")} failed with status ${result.status ?? "unknown"}`);
|
|
}
|
|
}
|
|
|
|
function formatCommand(command, args) {
|
|
return `${command} ${args.join(" ")}`;
|
|
}
|
|
|
|
function ensureNpmAuth() {
|
|
const result = runCommand("npm", ["whoami"]);
|
|
const stdout = result.stdout ?? "";
|
|
const stderr = result.stderr ?? "";
|
|
|
|
if (stdout) process.stdout.write(stdout);
|
|
if (stderr) process.stderr.write(stderr);
|
|
|
|
if (result.status === 0) {
|
|
return;
|
|
}
|
|
|
|
const output = `${stdout}\n${stderr}`.trim();
|
|
if (/\bE401\b|401 Unauthorized/i.test(output)) {
|
|
throw new Error(
|
|
[
|
|
"npm auth check failed.",
|
|
"This usually means the machine is either not logged into npm yet or has a stale token in ~/.npmrc.",
|
|
"Run `npm logout --registry=https://registry.npmjs.org/` and then `npm login` or `npm adduser` on this maintainer machine with an npm account that can publish to the @paperclipai scope, then rerun with --publish.",
|
|
"Do not use this auth flow in CI; it is only for the one-time human bootstrap publish.",
|
|
].join(" "),
|
|
);
|
|
}
|
|
|
|
throw new Error("npm whoami failed");
|
|
}
|
|
|
|
function inspectNpmPackage(packageName) {
|
|
const result = runCommand("npm", ["view", packageName, "version", "--json"]);
|
|
|
|
if (result.status === 0) {
|
|
const version = JSON.parse((result.stdout ?? "").trim());
|
|
return { exists: true, version };
|
|
}
|
|
|
|
const output = `${result.stdout ?? ""}\n${result.stderr ?? ""}`.trim();
|
|
if (/\bE404\b|404 Not Found|could not be found/i.test(output)) {
|
|
return { exists: false };
|
|
}
|
|
|
|
process.stderr.write(output ? `${output}\n` : "");
|
|
throw new Error(`failed to query npm for ${packageName}`);
|
|
}
|
|
|
|
function resolveTargetPackage(selector, packages = buildReleasePackagePlan()) {
|
|
const normalizedSelector = normalizePath(selector);
|
|
const matches = packages.filter(
|
|
(pkg) => pkg.name === selector || normalizePath(pkg.dir) === normalizedSelector,
|
|
);
|
|
|
|
if (matches.length === 1) {
|
|
return matches[0];
|
|
}
|
|
|
|
if (matches.length > 1) {
|
|
throw new Error(`package selector is ambiguous: ${selector}`);
|
|
}
|
|
|
|
throw new Error(
|
|
`unknown package selector: ${selector}\nKnown packages:\n- ${packages.map((pkg) => `${pkg.name} (${pkg.dir})`).join("\n- ")}`,
|
|
);
|
|
}
|
|
|
|
function printNextSteps(pkg) {
|
|
process.stdout.write(
|
|
[
|
|
"",
|
|
"Publish succeeded. Next:",
|
|
`1. Open https://www.npmjs.com/package/${pkg.name}`,
|
|
"2. Go to Settings -> Trusted publishing",
|
|
"3. Add repository paperclipai/paperclip",
|
|
"4. Set workflow filename to release.yml",
|
|
"5. Optionally enable Settings -> Publishing access -> Require two-factor authentication and disallow tokens",
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
}
|
|
|
|
function publishPackage(pkg, otp) {
|
|
const publishArgs = ["publish", "--access", "public"];
|
|
if (otp) {
|
|
publishArgs.push("--otp", otp);
|
|
}
|
|
|
|
const result = runCommand("npm", publishArgs, { cwd: join(repoRoot, pkg.dir) });
|
|
const stdout = result.stdout ?? "";
|
|
const stderr = result.stderr ?? "";
|
|
const output = `${stdout}\n${stderr}`.trim();
|
|
|
|
if (stdout) process.stdout.write(stdout);
|
|
if (stderr) process.stderr.write(stderr);
|
|
|
|
if (result.status === 0) {
|
|
return;
|
|
}
|
|
|
|
if (/\bEOTP\b|one-time password/i.test(output)) {
|
|
throw new Error(
|
|
[
|
|
"npm publish reached the publish-time 2FA check.",
|
|
"Complete the browser auth URL printed by npm and rerun the helper, or rerun with `--otp <code>` if your npm account uses authenticator-app codes.",
|
|
].join(" "),
|
|
);
|
|
}
|
|
|
|
throw new Error(`${formatCommand("npm", publishArgs)} failed with status ${result.status ?? "unknown"}`);
|
|
}
|
|
|
|
function main(argv) {
|
|
const { help, selector, publish, skipBuild, otp } = parseArgs(argv);
|
|
|
|
if (help) {
|
|
usage();
|
|
return;
|
|
}
|
|
|
|
if (!selector) {
|
|
usage();
|
|
throw new Error("missing package selector");
|
|
}
|
|
|
|
const pkg = resolveTargetPackage(selector);
|
|
process.stdout.write(`Selected ${pkg.name} (${pkg.dir})\n`);
|
|
|
|
if (publish && !otp) {
|
|
throw new Error("`--publish` requires `--otp <code>`. Generate a fresh npm one-time password and rerun.");
|
|
}
|
|
|
|
const npmState = inspectNpmPackage(pkg.name);
|
|
if (npmState.exists) {
|
|
throw new Error(`${pkg.name} already exists on npm at version ${npmState.version}; bootstrap is only for first publish`);
|
|
}
|
|
|
|
process.stdout.write(`${pkg.name} is not on npm yet; continuing with bootstrap flow.\n`);
|
|
|
|
if (publish) {
|
|
process.stdout.write("Checking npm auth with npm whoami...\n");
|
|
ensureNpmAuth();
|
|
}
|
|
|
|
if (!skipBuild && typeof pkg.pkg?.scripts?.build === "string") {
|
|
process.stdout.write(`Building ${pkg.name}...\n`);
|
|
runChecked("pnpm", ["--filter", pkg.name, "build"]);
|
|
}
|
|
|
|
process.stdout.write(`Previewing publish payload for ${pkg.name}...\n`);
|
|
runChecked("npm", ["pack", "--dry-run"], { cwd: join(repoRoot, pkg.dir) });
|
|
|
|
if (!publish) {
|
|
process.stdout.write(
|
|
[
|
|
"",
|
|
"Dry run complete. To perform the first publish from an authenticated maintainer machine, run:",
|
|
`node scripts/bootstrap-npm-package.mjs ${pkg.name} --publish --otp <code>`,
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
return;
|
|
}
|
|
|
|
process.stdout.write(`Publishing ${pkg.name}...\n`);
|
|
publishPackage(pkg, otp);
|
|
printNextSteps(pkg);
|
|
}
|
|
|
|
const isDirectRun = process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url);
|
|
|
|
if (isDirectRun) {
|
|
try {
|
|
main(process.argv.slice(2));
|
|
} catch (error) {
|
|
process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
process.exit(1);
|
|
}
|
|
}
|
|
|
|
export {
|
|
ensureNpmAuth,
|
|
inspectNpmPackage,
|
|
parseArgs,
|
|
publishPackage,
|
|
resolveTargetPackage,
|
|
};
|