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>
181 lines
5.8 KiB
Python
181 lines
5.8 KiB
Python
#!/usr/bin/env python3
|
|
"""Synchronize version across all headroom packages."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import json
|
|
import re
|
|
from pathlib import Path
|
|
|
|
try:
|
|
import tomllib
|
|
except ImportError: # pragma: no cover - Python 3.10 fallback
|
|
import tomli as tomllib
|
|
|
|
|
|
def get_version_from_pyproject(root: Path) -> str:
|
|
"""Read version from pyproject.toml."""
|
|
pyproject_path = root / "pyproject.toml"
|
|
with open(pyproject_path, "rb") as f:
|
|
data = tomllib.load(f)
|
|
return data["project"]["version"]
|
|
|
|
|
|
def bump_version(version: str, bump_type: str) -> str:
|
|
"""Bump version according to bump_type (major, minor, patch)."""
|
|
major, minor, patch = map(int, version.split("."))
|
|
if bump_type == "major":
|
|
major += 1
|
|
minor = 0
|
|
patch = 0
|
|
elif bump_type == "minor":
|
|
minor += 1
|
|
patch = 0
|
|
elif bump_type == "patch":
|
|
patch += 1
|
|
return f"{major}.{minor}.{patch}"
|
|
|
|
|
|
def update_package_json(file_path: Path, version: str) -> None:
|
|
"""Update a package.json version field."""
|
|
with open(file_path, encoding="utf-8") as f:
|
|
data = json.load(f)
|
|
data["version"] = version
|
|
with open(file_path, "w", encoding="utf-8") as f:
|
|
json.dump(data, f, indent=2, ensure_ascii=False)
|
|
f.write("\n")
|
|
|
|
|
|
def update_plugin_manifest(file_path: Path, version: str) -> None:
|
|
"""Update a plugin.json version field."""
|
|
with open(file_path, encoding="utf-8") as f:
|
|
data = json.load(f)
|
|
data["version"] = version
|
|
with open(file_path, "w", encoding="utf-8") as f:
|
|
json.dump(data, f, indent=2, ensure_ascii=False)
|
|
f.write("\n")
|
|
|
|
|
|
def update_marketplace_manifest(file_path: Path, version: str) -> None:
|
|
"""Update marketplace metadata and plugin entry versions."""
|
|
with open(file_path, encoding="utf-8") as f:
|
|
data = json.load(f)
|
|
metadata = data.get("metadata")
|
|
if isinstance(metadata, dict):
|
|
metadata["version"] = version
|
|
plugins = data.get("plugins")
|
|
if isinstance(plugins, list):
|
|
for plugin in plugins:
|
|
if isinstance(plugin, dict):
|
|
plugin["version"] = version
|
|
with open(file_path, "w", encoding="utf-8") as f:
|
|
json.dump(data, f, indent=2, ensure_ascii=False)
|
|
f.write("\n")
|
|
|
|
|
|
def update_plugin_versions(root: Path, version: str) -> None:
|
|
"""Update marketplace and plugin manifest versions."""
|
|
update_marketplace_manifest(root / ".claude-plugin" / "marketplace.json", version)
|
|
update_marketplace_manifest(root / ".github" / "plugin" / "marketplace.json", version)
|
|
update_plugin_manifest(
|
|
root / "plugins" / "headroom-agent-hooks" / ".claude-plugin" / "plugin.json", version
|
|
)
|
|
update_plugin_manifest(
|
|
root / "plugins" / "headroom-agent-hooks" / ".github" / "plugin" / "plugin.json",
|
|
version,
|
|
)
|
|
|
|
|
|
def update_openclaw_package_json(file_path: Path, version: str) -> None:
|
|
"""Update openclaw package.json version.
|
|
|
|
Keep the source `headroom-ai` dependency registry-installable. The release
|
|
workflow rewrites the packed tgz dependency to the exact release range after
|
|
the local SDK tarball is available.
|
|
"""
|
|
with open(file_path, encoding="utf-8") as f:
|
|
data = json.load(f)
|
|
data["version"] = version
|
|
with open(file_path, "w", encoding="utf-8") as f:
|
|
json.dump(data, f, indent=2, ensure_ascii=False)
|
|
f.write("\n")
|
|
|
|
|
|
def update_pyproject_version(root: Path, version: str) -> None:
|
|
"""Update pyproject.toml version."""
|
|
pyproject_path = root / "pyproject.toml"
|
|
content = pyproject_path.read_text(encoding="utf-8")
|
|
updated = re.sub(
|
|
r'^version = "[^"]+"',
|
|
f'version = "{version}"',
|
|
content,
|
|
flags=re.MULTILINE,
|
|
)
|
|
pyproject_path.write_text(updated, encoding="utf-8")
|
|
|
|
|
|
def write_release_metadata(root: Path, version: str) -> None:
|
|
"""Write .releasemetadata JSON file."""
|
|
metadata = {
|
|
"version": version,
|
|
"packages": {
|
|
"pypi": version,
|
|
"npm-sdk": version,
|
|
"npm-openclaw": version,
|
|
"agent-hooks-plugin": version,
|
|
},
|
|
}
|
|
metadata_path = root / ".releasemetadata"
|
|
with open(metadata_path, "w", encoding="utf-8") as f:
|
|
json.dump(metadata, f, indent=2, ensure_ascii=False)
|
|
f.write("\n")
|
|
|
|
|
|
def main() -> None:
|
|
parser = argparse.ArgumentParser(description="Synchronize version across headroom packages")
|
|
parser.add_argument(
|
|
"--root",
|
|
type=Path,
|
|
default=Path(__file__).parent.parent,
|
|
help="Root directory of the project",
|
|
)
|
|
group = parser.add_mutually_exclusive_group()
|
|
group.add_argument("--version", help="Explicit version to set (e.g., 0.6.0)")
|
|
group.add_argument(
|
|
"--bump",
|
|
choices=["major", "minor", "patch"],
|
|
help="Bump version from pyproject.toml",
|
|
)
|
|
parser.add_argument(
|
|
"--plugin-manifests-only",
|
|
action="store_true",
|
|
help="Only update marketplace/plugin manifest versions",
|
|
)
|
|
args = parser.parse_args()
|
|
|
|
if args.version:
|
|
version = args.version
|
|
elif args.bump:
|
|
base_version = get_version_from_pyproject(args.root)
|
|
version = bump_version(base_version, args.bump)
|
|
else:
|
|
version = get_version_from_pyproject(args.root)
|
|
|
|
if args.plugin_manifests_only:
|
|
update_plugin_versions(args.root, version)
|
|
print(f"Plugin versions synchronized to {version}")
|
|
return
|
|
|
|
# Update all versioned files
|
|
update_pyproject_version(args.root, version)
|
|
update_openclaw_package_json(args.root / "plugins" / "openclaw" / "package.json", version)
|
|
update_package_json(args.root / "sdk" / "typescript" / "package.json", version)
|
|
update_plugin_versions(args.root, version)
|
|
write_release_metadata(args.root, version)
|
|
|
|
print(f"Version synchronized to {version}")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|