mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description
Harden the release artifact workflow so maintainers can reproduce npm
and Python release checks locally and so OpenClaw packaging does not
depend on a not-yet-published SDK version. This follow-up also keeps the
OpenClaw loader export contract explicit and updates the PR after the
branch was merged with current `headroomlabs/main`.
## Type of Change
- [x] Bug fix (non-breaking change that fixes an issue)
- [x] New feature (non-breaking change that adds functionality)
- [x] Documentation update
## Changes Made
- Added reusable local release smoke scripts for npm assets, Python
wheel/sdist artifacts, and the combined release gate.
- Switched the release workflow npm asset build to the reusable npm
builder.
- Made OpenClaw release asset building install against the just-built
local SDK tarball before rewriting packed metadata to the release
dependency range.
- Kept the OpenClaw source dependency registry-installable at
`headroom-ai@^0.22.3` while the packed artifact still ships
`^<release-version>`.
- Added `registerHeadroomPlugin` as a named export while preserving the
default `{ register }` OpenClaw loader contract.
- Added Windows development bootstrap docs/script and regression tests
for version sync, npm asset ordering, OpenClaw source installability,
and Python wheel smoke import isolation.
## Testing
- [x] Unit tests pass (`pytest`)
- [x] New tests added for new functionality
- [x] Manual testing performed
### Test Output
```text
uv run --with pytest python -m pytest tests/test_release_workflows.py scripts/tests/test_version_sync.py -q
44 passed, 1 warning
node --check scripts/build_npm_release_assets.mjs
node --check scripts/verify_npm_release_assets.mjs
python -m py_compile scripts/build_python_release_smoke.py scripts/release_smoke_all.py scripts/version-sync.py
python scripts/verify-versions.py
All versions aligned at 0.31.0
npm ci (plugins/openclaw)
added 88 packages, audited 89 packages, found 0 vulnerabilities
python scripts/release_smoke_all.py --out release-assets-local/all-pr1824-postmerge-fixed-20260710-104739
Verified npm release assets for 0.31.0
wheel metadata OK: headroom_ai-0.31.0-cp310-abi3-win_amd64.whl contains headroom/_core.pyd
sdist License-File metadata OK: ['LICENSE', 'NOTICE']
smoke-import OK: version=0.31.0 hello=headroom-core
```
## Real Behavior Proof
- Environment: Windows 11, Python 3.14.3, Node v24.14.0, npm 11.9.0, uv
0.11.15, Rust/Cargo already installed in the local development
environment.
- Exact command / steps: Ran `python scripts/release_smoke_all.py --out
release-assets-local/all-pr1824-postmerge-fixed-20260710-104739` after
syncing this branch with current `headroomlabs/main`.
- Observed result: The command built `headroom-ai-0.31.0.tgz`,
`headroom-openclaw-0.31.0.tgz`,
`headroom_ai-0.31.0-cp310-abi3-win_amd64.whl`, and
`headroom_ai-0.31.0.tar.gz`; npm verifier passed; the wheel installed
into a fresh venv and imported `headroom._core`.
- Not tested: Full GitHub Actions release matrix and publish jobs with
real PyPI/npm/GitHub Packages credentials.
## Review Readiness
- [x] I have performed a self-review
- [x] This PR is ready for human review
## Checklist
- [x] My code follows the project's style guidelines
- [x] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] I have updated the CHANGELOG.md if applicable
## Screenshots (if applicable)
N/A.
## Additional Notes
The post-merge full smoke initially failed because the OpenClaw source
package depended on `headroom-ai@^0.31.0`, which is not available on
public npm yet. The builder now installs OpenClaw against the just-built
local SDK tarball before build/pack, and then rewrites packed metadata
to `^0.31.0`.
---------
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
Co-authored-by: Tejas Chopra <chopratejas@gmail.com>
175 lines
5.3 KiB
JavaScript
175 lines
5.3 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import { copyFileSync, mkdtempSync, readFileSync, rmSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { spawnSync } from "node:child_process";
|
|
|
|
const [assetsDirArg, version] = process.argv.slice(2);
|
|
|
|
if (!assetsDirArg || !version) {
|
|
console.error("Usage: node scripts/verify_npm_release_assets.mjs <assets-dir> <version>");
|
|
process.exit(2);
|
|
}
|
|
|
|
const assetsDir = path.resolve(assetsDirArg);
|
|
|
|
const packages = [
|
|
{
|
|
name: "headroom-ai",
|
|
tarball: `headroom-ai-${version}.tgz`,
|
|
},
|
|
{
|
|
name: "headroom-openclaw",
|
|
tarball: `headroom-openclaw-${version}.tgz`,
|
|
dependencies: {
|
|
"headroom-ai": `^${version}`,
|
|
},
|
|
},
|
|
];
|
|
|
|
const tarballPaths = new Map();
|
|
|
|
function extractPackageJson(tarballPath) {
|
|
return extractJsonFromTarball(tarballPath, "package/package.json");
|
|
}
|
|
|
|
function extractDistPackageJson(tarballPath) {
|
|
return extractJsonFromTarball(tarballPath, "package/dist/package.json");
|
|
}
|
|
|
|
function extractJsonFromTarball(tarballPath, packageJsonPath) {
|
|
const workdir = mkdtempSync(path.join(tmpdir(), "headroom-npm-asset-"));
|
|
try {
|
|
const result = spawnSync("tar", ["-xzf", tarballPath, "-C", workdir], {
|
|
encoding: "utf8",
|
|
});
|
|
if (result.status !== 0) {
|
|
throw new Error(
|
|
`tar failed for ${tarballPath}: ${result.stderr || result.stdout || "unknown error"}`,
|
|
);
|
|
}
|
|
return JSON.parse(readFileSync(path.join(workdir, packageJsonPath), "utf8"));
|
|
} finally {
|
|
rmSync(workdir, { recursive: true, force: true });
|
|
}
|
|
}
|
|
|
|
function assertNoFileDependencies(pkg) {
|
|
for (const field of ["dependencies", "peerDependencies", "optionalDependencies"]) {
|
|
for (const [name, spec] of Object.entries(pkg[field] || {})) {
|
|
if (typeof spec === "string" && (spec.startsWith("file:") || spec.includes("release-assets"))) {
|
|
throw new Error(`${pkg.name} has non-portable ${field}.${name} spec: ${spec}`);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function runNpm(args, cwd) {
|
|
if (process.platform === "win32") {
|
|
return spawnSync("cmd.exe", ["/d", "/s", "/c", "npm.cmd", ...args], {
|
|
cwd,
|
|
encoding: "utf8",
|
|
});
|
|
}
|
|
|
|
return spawnSync("npm", args, {
|
|
cwd,
|
|
encoding: "utf8",
|
|
});
|
|
}
|
|
|
|
function assertOpenClawExtensionContract(cwd) {
|
|
const smoke = `
|
|
const mod = await import("headroom-openclaw");
|
|
if (typeof mod.default?.register !== "function") {
|
|
throw new Error("headroom-openclaw default export must expose register(api)");
|
|
}
|
|
if (typeof mod.registerHeadroomPlugin !== "function") {
|
|
throw new Error("headroom-openclaw must export registerHeadroomPlugin(api)");
|
|
}
|
|
if (mod.default.register !== mod.registerHeadroomPlugin) {
|
|
throw new Error("headroom-openclaw default.register must match registerHeadroomPlugin");
|
|
}
|
|
`;
|
|
const result = spawnSync(process.execPath, ["--input-type=module", "-e", smoke], {
|
|
cwd,
|
|
encoding: "utf8",
|
|
});
|
|
if (result.status !== 0) {
|
|
throw new Error(
|
|
`headroom-openclaw import smoke failed: ${
|
|
result.error?.message || result.stderr || result.stdout || "unknown error"
|
|
}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
for (const expected of packages) {
|
|
const tarballPath = path.join(assetsDir, expected.tarball);
|
|
tarballPaths.set(expected.name, tarballPath);
|
|
const pkg = extractPackageJson(tarballPath);
|
|
|
|
if (pkg.name !== expected.name) {
|
|
throw new Error(`${expected.tarball} package name mismatch: expected ${expected.name}, got ${pkg.name}`);
|
|
}
|
|
if (pkg.version !== version) {
|
|
throw new Error(`${expected.tarball} version mismatch: expected ${version}, got ${pkg.version}`);
|
|
}
|
|
|
|
assertNoFileDependencies(pkg);
|
|
|
|
for (const [name, spec] of Object.entries(expected.dependencies || {})) {
|
|
const actual = pkg.dependencies?.[name];
|
|
if (actual !== spec) {
|
|
throw new Error(`${pkg.name} dependency ${name} mismatch: expected ${spec}, got ${actual}`);
|
|
}
|
|
}
|
|
|
|
if (expected.name === "headroom-openclaw") {
|
|
const distPkg = extractDistPackageJson(tarballPath);
|
|
if (distPkg.name !== expected.name) {
|
|
throw new Error(`${expected.tarball} dist package name mismatch: expected ${expected.name}, got ${distPkg.name}`);
|
|
}
|
|
if (distPkg.version !== version) {
|
|
throw new Error(`${expected.tarball} dist package version mismatch: expected ${version}, got ${distPkg.version}`);
|
|
}
|
|
assertNoFileDependencies(distPkg);
|
|
for (const [name, spec] of Object.entries(expected.dependencies || {})) {
|
|
const actual = distPkg.dependencies?.[name];
|
|
if (actual !== spec) {
|
|
throw new Error(`${distPkg.name} dist dependency ${name} mismatch: expected ${spec}, got ${actual}`);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
const installDir = mkdtempSync(path.join(tmpdir(), "headroom-npm-install-"));
|
|
try {
|
|
for (const expected of packages) {
|
|
copyFileSync(tarballPaths.get(expected.name), path.join(installDir, expected.tarball));
|
|
}
|
|
const result = runNpm(
|
|
[
|
|
"install",
|
|
"--ignore-scripts",
|
|
"--no-audit",
|
|
"--no-fund",
|
|
`./${packages[0].tarball}`,
|
|
`./${packages[1].tarball}`,
|
|
],
|
|
installDir,
|
|
);
|
|
if (result.status !== 0) {
|
|
throw new Error(
|
|
`clean npm install failed: ${
|
|
result.error?.message || result.stderr || result.stdout || "unknown error"
|
|
}`,
|
|
);
|
|
}
|
|
assertOpenClawExtensionContract(installDir);
|
|
} finally {
|
|
rmSync(installDir, { recursive: true, force: true });
|
|
}
|
|
|
|
console.log(`Verified npm release assets for ${version}`);
|