mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-17 21:34:48 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Every master push runs a canary, and only one canary at a time may run the release workflow > - After #21554 and #21555 a canary held that lock for 35.5 min, and 13-16 min of it was waiting for npm to show the new packages > - The wait was required: the next canary computed `canary.N` from npm's version list, so starting before npm showed the previous canary would reuse its number > - This pull request numbers a canary by its commit's position on master and moves the registry confirmation, the git tag, the Docker dispatch and the onboarding smoke to a separate `canary-finalize.yml` run > - The benefit is that the release lock is held for about 20-25 min per canary instead of 35, with the same checks before a canary is tagged ## Linked Issues or Issue Description **What existing behavior does this improve?** Canary throughput. In run 43715037497 (2026-11-15) `publish_canary` took 23.7 min, and 13.3 min of that was "Waiting for registry visibility" (13:08:50 to 13:22:11). The next canary could not start until that run ended. **Current behavior** `release.sh canary` sets `N` to (highest published `-canary.N` for today) + 1, then publishes, waits for npm to show every package, checks dist-tags, installs `paperclipai@canary`, and creates `canary/v<version>`. `publish_canary` pushes the tag, dispatches `docker.yml`, and `smoke_canary_onboarding` runs in the same run. **Proposed behavior** `N` = `git rev-list --count HEAD` (full history required), or the registry number + 1 when that is higher (a rerun of the same commit). `release.sh canary --defer-registry-confirmation` ends after npm accepts every publish. `publish_canary` dispatches `canary-finalize.yml`, which does the confirmation, tag, Docker dispatch and smoke outside the release lock. Nightly, beta and stable numbering and flow are unchanged. Refs #21554, #21555 ## What Changed - `scripts/release-lib.sh`: `next_canary_version_from_source`. A publishing canary refuses a shallow checkout; a dry run (the PR Canary Dry Run job) falls back to the registry number. - `scripts/release.sh`: canary uses the new number; new canary-only `--defer-registry-confirmation` flag skips the registry wait, the dist-tag check and the local tag, and writes the version to `PAPERCLIP_RELEASE_VERSION_FILE`. - `scripts/confirm-canary-publication.sh` (new): waits for registry visibility, checks provenance, checks dist-tags with `--allow-newer-canary`, installs `paperclipai@<version>`, then creates and pushes `canary/v<version>`. A tag already on the same commit is accepted, so reruns are safe. - `scripts/verify-canary-provenance.mjs` (new): every package's npm SLSA provenance must name `.github/workflows/release.yml` on `refs/heads/master` in `paperclipai/paperclip` at the source commit. A dispatch with invented inputs cannot tag anything. - `scripts/verify-release-registry-state.mjs`: `--allow-newer-canary` accepts a `canary` dist-tag that a newer canary already moved; older, foreign or missing tags still fail. - `.github/workflows/canary-finalize.yml` (new, `workflow_dispatch`, master only): `confirm_canary` (contents: write, actions: write) and `smoke_canary_onboarding` (downloads the publisher's lockfile artifact by run id). Inputs reach shell steps only through a validating step. - `.github/workflows/release.yml`: `publish_canary` hands off to `canary-finalize.yml` and drops to `contents: read`; its tag push, Docker dispatch and smoke job move to `canary-finalize.yml`. - Tests and `doc/RELEASING.md`. ## Verification - `node --test .github/scripts/tests/*.test.mjs scripts/release-lib.test.mjs scripts/verify-release-registry-state.test.mjs scripts/verify-canary-provenance.test.mjs`: 846 pass. `scripts/__tests__/release-verify-workflow.test.mjs`: 73 pass. - New tests: numbering by master position, rerun moves past a published number, shallow refusal and dry-run fallback; newer/older/foreign dist-tags; provenance from another commit, workflow, branch, repository or package is rejected; finalize wiring, permissions and input handling. - Real npm data: `verify-canary-provenance.mjs 2026.1116.0-canary.7 b4fa1c7f... paperclipai @paperclipai/shared @paperclipai/server` passes; the same version with another commit fails. - `confirm-canary-publication.sh 2026.1116.0-canary.7 b4fa1c7f...` from a checkout of that commit ran all steps against npm in 61 s and ended with "canary/v2026.1116.0-canary.7 already points at b4fa1c7f...", pushing nothing. - `release.sh canary --dry-run --defer-registry-confirmation` and `release.sh nightly --defer-registry-confirmation` both stop with "only applies to a published canary". - `actionlint` reports no new findings compared with master. - Not verified before merge: a full publish through `canary-finalize.yml`. It can run only from master. The first canary after merge is the check. ## Risks - Canary numbers jump from `canary.7` to about `canary.8144` (master has 8,143 commits). This is valid semver and still higher than every earlier canary; users install through the `canary` dist-tag. - The `canary/v` tag, Docker image and smoke now finish after the release run ends. Nightly selects only tagged canaries, as before. If finalize fails, that canary is on npm without a tag, so nightly skips it, as it skips any canary whose old in-run verification failed. - A canary can now publish while the previous one is still being confirmed. Publishing itself is still serialized, so the `canary` dist-tag only moves forward. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, in Claude Code with tool use and code execution. ## 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 searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [ ] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
103 lines
4.4 KiB
JavaScript
103 lines
4.4 KiB
JavaScript
#!/usr/bin/env node
|
|
import { pathToFileURL } from "node:url";
|
|
|
|
export const RELEASE_WORKFLOW = Object.freeze({
|
|
repository: "https://github.com/paperclipai/paperclip",
|
|
path: ".github/workflows/release.yml",
|
|
ref: "refs/heads/master",
|
|
});
|
|
|
|
const CANARY_VERSION = /^\d+\.\d+\.\d+-canary\.\d+$/;
|
|
const SHA = /^[0-9a-f]{40}$/;
|
|
|
|
function slsaStatements(attestations) {
|
|
return (attestations?.attestations ?? [])
|
|
.filter((entry) => typeof entry?.predicateType === "string" && entry.predicateType.startsWith("https://slsa.dev/provenance/"))
|
|
.map((entry) => {
|
|
try {
|
|
return JSON.parse(Buffer.from(entry.bundle?.dsseEnvelope?.payload ?? "", "base64").toString("utf8"));
|
|
} catch {
|
|
return null;
|
|
}
|
|
})
|
|
.filter(Boolean);
|
|
}
|
|
|
|
export function packageProvenance(attestations, { packageName, version, sourceSha }) {
|
|
const subject = `pkg:npm/${packageName.replace(/^@/, "%40")}@${version}`;
|
|
const statements = slsaStatements(attestations);
|
|
if (statements.length === 0) return "none";
|
|
const matches = statements.some((statement) => {
|
|
const workflow = statement.predicate?.buildDefinition?.externalParameters?.workflow ?? {};
|
|
const commit = statement.predicate?.buildDefinition?.resolvedDependencies?.[0]?.digest?.gitCommit;
|
|
return statement.subject?.some((entry) => entry?.name === subject)
|
|
&& workflow.repository === RELEASE_WORKFLOW.repository
|
|
&& workflow.path === RELEASE_WORKFLOW.path
|
|
&& workflow.ref === RELEASE_WORKFLOW.ref
|
|
&& commit === sourceSha;
|
|
});
|
|
return matches ? "match" : "mismatch";
|
|
}
|
|
|
|
const TRANSIENT = new Set([408, 425, 429, 500, 502, 503, 504]);
|
|
|
|
async function fetchAttestations(url, { fetcher, attempts, sleep }) {
|
|
let lastError;
|
|
for (let attempt = 1; attempt <= attempts; attempt += 1) {
|
|
try {
|
|
const response = await fetcher(url, { signal: AbortSignal.timeout(30_000) });
|
|
if (response.status === 404) return null;
|
|
if (response.ok) return await response.json();
|
|
if (!TRANSIENT.has(response.status)) throw Object.assign(new Error(`HTTP ${response.status}`), { permanent: true });
|
|
lastError = new Error(`HTTP ${response.status}`);
|
|
} catch (error) {
|
|
if (error.permanent) throw error;
|
|
lastError = error;
|
|
}
|
|
if (attempt < attempts) await sleep(Math.min(30_000, 1_000 * 2 ** (attempt - 1)));
|
|
}
|
|
throw lastError;
|
|
}
|
|
|
|
export async function verifyCanaryProvenance({ packages, version, sourceSha, fetcher = fetch, attempts = 5,
|
|
sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) }) {
|
|
if (!CANARY_VERSION.test(version ?? "")) throw new Error(`not a canary version: ${version}`);
|
|
if (!SHA.test(sourceSha ?? "")) throw new Error(`not a full commit SHA: ${sourceSha}`);
|
|
if (!packages?.length) throw new Error("at least one package is required");
|
|
const problems = [];
|
|
const withoutProvenance = [];
|
|
let matched = 0;
|
|
for (const packageName of packages) {
|
|
const url = `https://registry.npmjs.org/-/npm/v1/attestations/${encodeURIComponent(packageName).replace(/^%40/, "@")}@${version}`;
|
|
let attestations;
|
|
try {
|
|
attestations = await fetchAttestations(url, { fetcher, attempts, sleep });
|
|
} catch (error) {
|
|
problems.push(`${packageName}@${version}: attestations unavailable (${error.message})`);
|
|
continue;
|
|
}
|
|
const result = attestations ? packageProvenance(attestations, { packageName, version, sourceSha }) : "none";
|
|
if (result === "match") matched += 1;
|
|
else if (result === "none") withoutProvenance.push(packageName);
|
|
else problems.push(`${packageName}@${version}: provenance does not name ${RELEASE_WORKFLOW.path} on ${RELEASE_WORKFLOW.ref} at ${sourceSha}`);
|
|
}
|
|
return { problems, matched, withoutProvenance };
|
|
}
|
|
|
|
if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
|
|
const [version, sourceSha, ...packages] = process.argv.slice(2);
|
|
try {
|
|
const { problems, matched, withoutProvenance } = await verifyCanaryProvenance({ packages, version, sourceSha });
|
|
if (problems.length) {
|
|
for (const problem of problems) console.error(problem);
|
|
process.exitCode = 1;
|
|
} else {
|
|
console.log(`Provenance for ${matched} of ${packages.length} packages names ${RELEASE_WORKFLOW.path} at ${sourceSha}.`);
|
|
if (withoutProvenance.length) console.log(`Published without provenance (npm transparency-log retry): ${withoutProvenance.join(", ")}`);
|
|
}
|
|
} catch (error) {
|
|
console.error(error.message);
|
|
process.exitCode = 1;
|
|
}
|
|
}
|