mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
5709291914
## 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>
322 lines
12 KiB
Python
322 lines
12 KiB
Python
"""Tests for version-sync.py."""
|
|
|
|
import json
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
|
|
@pytest.fixture
|
|
def temp_project(tmp_path: Path) -> dict[str, Path]:
|
|
"""Create a temporary project with all versioned files."""
|
|
# Create directory structure
|
|
root = tmp_path / "project"
|
|
headroom = root / "headroom"
|
|
headroom.mkdir(parents=True)
|
|
repo_claude_plugin = root / ".claude-plugin"
|
|
repo_claude_plugin.mkdir(parents=True)
|
|
repo_github_plugin = root / ".github" / "plugin"
|
|
repo_github_plugin.mkdir(parents=True)
|
|
plugins = root / "plugins"
|
|
openclaw = plugins / "openclaw"
|
|
openclaw.mkdir(parents=True)
|
|
agent_hooks_claude = plugins / "headroom-agent-hooks" / ".claude-plugin"
|
|
agent_hooks_claude.mkdir(parents=True)
|
|
agent_hooks_github = plugins / "headroom-agent-hooks" / ".github" / "plugin"
|
|
agent_hooks_github.mkdir(parents=True)
|
|
sdk = root / "sdk"
|
|
typescript = sdk / "typescript"
|
|
typescript.mkdir(parents=True)
|
|
|
|
# pyproject.toml
|
|
pyproject = root / "pyproject.toml"
|
|
pyproject.write_text('[project]\nversion = "0.5.25"\n')
|
|
|
|
# headroom/_version.py is runtime-derived and must not be rewritten by version-sync.
|
|
version_py = headroom / "_version.py"
|
|
version_py.write_text('"""Package version metadata."""\n\n__version__ = "0.5.25"\n')
|
|
|
|
# plugins/openclaw/package.json
|
|
openclaw_pkg = openclaw / "package.json"
|
|
openclaw_pkg.write_text(
|
|
json.dumps(
|
|
{
|
|
"name": "test",
|
|
"version": "0.5.25",
|
|
"dependencies": {"headroom-ai": "^0.22.3"},
|
|
}
|
|
)
|
|
)
|
|
|
|
repo_claude_marketplace = repo_claude_plugin / "marketplace.json"
|
|
repo_claude_marketplace.write_text(
|
|
json.dumps(
|
|
{
|
|
"metadata": {"name": "claude-marketplace", "version": "0.1.0"},
|
|
"plugins": [{"name": "headroom-agent-hooks", "version": "0.1.0"}],
|
|
}
|
|
)
|
|
)
|
|
|
|
repo_github_marketplace = repo_github_plugin / "marketplace.json"
|
|
repo_github_marketplace.write_text(
|
|
json.dumps(
|
|
{
|
|
"metadata": {"name": "copilot-marketplace", "version": "0.1.0"},
|
|
"plugins": [{"name": "headroom-agent-hooks", "version": "0.1.0"}],
|
|
}
|
|
)
|
|
)
|
|
|
|
claude_plugin = agent_hooks_claude / "plugin.json"
|
|
claude_plugin.write_text(json.dumps({"name": "headroom-agent-hooks", "version": "0.1.0"}))
|
|
|
|
github_plugin = agent_hooks_github / "plugin.json"
|
|
github_plugin.write_text(json.dumps({"name": "headroom-agent-hooks", "version": "0.1.0"}))
|
|
|
|
# sdk/typescript/package.json
|
|
typescript_pkg = typescript / "package.json"
|
|
typescript_pkg.write_text(json.dumps({"name": "test", "version": "0.5.25"}))
|
|
|
|
return {
|
|
"root": root,
|
|
"pyproject": pyproject,
|
|
"version_py": version_py,
|
|
"openclaw_pkg": openclaw_pkg,
|
|
"repo_claude_marketplace": repo_claude_marketplace,
|
|
"repo_github_marketplace": repo_github_marketplace,
|
|
"claude_plugin": claude_plugin,
|
|
"github_plugin": github_plugin,
|
|
"typescript_pkg": typescript_pkg,
|
|
}
|
|
|
|
|
|
def test_version_sync_explicit_version(temp_project: dict[str, Path]) -> None:
|
|
"""Test --version flag updates all files."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--version", "0.7.0"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify pyproject.toml
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "0.7.0"' in pyproject_content
|
|
|
|
# Verify headroom/_version.py is not a synced manifest.
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
# Verify plugins/openclaw/package.json
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.7.0"
|
|
assert openclaw_pkg["dependencies"]["headroom-ai"] == "^0.22.3"
|
|
|
|
# Verify sdk/typescript/package.json
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "0.7.0"
|
|
|
|
repo_claude_marketplace = json.loads(temp_project["repo_claude_marketplace"].read_text())
|
|
assert repo_claude_marketplace["metadata"]["version"] == "0.7.0"
|
|
assert repo_claude_marketplace["plugins"][0]["version"] == "0.7.0"
|
|
|
|
repo_github_marketplace = json.loads(temp_project["repo_github_marketplace"].read_text())
|
|
assert repo_github_marketplace["metadata"]["version"] == "0.7.0"
|
|
assert repo_github_marketplace["plugins"][0]["version"] == "0.7.0"
|
|
|
|
claude_plugin = json.loads(temp_project["claude_plugin"].read_text())
|
|
assert claude_plugin["version"] == "0.7.0"
|
|
|
|
github_plugin = json.loads(temp_project["github_plugin"].read_text())
|
|
assert github_plugin["version"] == "0.7.0"
|
|
|
|
# Verify .releasemetadata was created
|
|
release_metadata = root / ".releasemetadata"
|
|
assert release_metadata.exists()
|
|
metadata = json.loads(release_metadata.read_text())
|
|
assert metadata["version"] == "0.7.0"
|
|
assert metadata["packages"]["pypi"] == "0.7.0"
|
|
assert metadata["packages"]["npm-sdk"] == "0.7.0"
|
|
assert metadata["packages"]["npm-openclaw"] == "0.7.0"
|
|
assert metadata["packages"]["agent-hooks-plugin"] == "0.7.0"
|
|
|
|
|
|
def test_bump_patch(temp_project: dict[str, Path]) -> None:
|
|
"""Test --bump patch bumps 0.5.25 to 0.5.26."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--bump", "patch"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify all files updated to 0.5.26
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "0.5.26"' in pyproject_content
|
|
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.5.26"
|
|
assert openclaw_pkg["dependencies"]["headroom-ai"] == "^0.22.3"
|
|
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "0.5.26"
|
|
|
|
claude_plugin = json.loads(temp_project["claude_plugin"].read_text())
|
|
assert claude_plugin["version"] == "0.5.26"
|
|
|
|
|
|
def test_bump_minor(temp_project: dict[str, Path]) -> None:
|
|
"""Test --bump minor bumps 0.5.25 to 0.6.0."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--bump", "minor"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify all files updated to 0.6.0
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "0.6.0"' in pyproject_content
|
|
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.6.0"
|
|
assert openclaw_pkg["dependencies"]["headroom-ai"] == "^0.22.3"
|
|
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "0.6.0"
|
|
|
|
github_plugin = json.loads(temp_project["github_plugin"].read_text())
|
|
assert github_plugin["version"] == "0.6.0"
|
|
|
|
|
|
def test_bump_major(temp_project: dict[str, Path]) -> None:
|
|
"""Test --bump major bumps 0.5.25 to 1.0.0."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--bump", "major"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
# Verify all files updated to 1.0.0
|
|
pyproject_content = temp_project["pyproject"].read_text()
|
|
assert 'version = "1.0.0"' in pyproject_content
|
|
|
|
version_py_content = temp_project["version_py"].read_text()
|
|
assert '__version__ = "0.5.25"' in version_py_content
|
|
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "1.0.0"
|
|
assert openclaw_pkg["dependencies"]["headroom-ai"] == "^0.22.3"
|
|
|
|
typescript_pkg = json.loads(temp_project["typescript_pkg"].read_text())
|
|
assert typescript_pkg["version"] == "1.0.0"
|
|
|
|
repo_claude_marketplace = json.loads(temp_project["repo_claude_marketplace"].read_text())
|
|
assert repo_claude_marketplace["metadata"]["version"] == "1.0.0"
|
|
|
|
|
|
def test_release_metadata_written(temp_project: dict[str, Path]) -> None:
|
|
"""Test .releasemetadata is written correctly."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--version", "0.6.0"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
|
|
release_metadata = root / ".releasemetadata"
|
|
assert release_metadata.exists()
|
|
|
|
metadata = json.loads(release_metadata.read_text())
|
|
assert metadata == {
|
|
"version": "0.6.0",
|
|
"packages": {
|
|
"pypi": "0.6.0",
|
|
"npm-sdk": "0.6.0",
|
|
"npm-openclaw": "0.6.0",
|
|
"agent-hooks-plugin": "0.6.0",
|
|
},
|
|
}
|
|
|
|
|
|
def test_plugin_manifests_only_leaves_package_versions_unchanged(
|
|
temp_project: dict[str, Path],
|
|
) -> None:
|
|
"""Test plugin-only sync leaves canonical package versions alone."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[
|
|
sys.executable,
|
|
str(script),
|
|
"--root",
|
|
str(root),
|
|
"--version",
|
|
"0.8.0",
|
|
"--plugin-manifests-only",
|
|
],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
assert 'version = "0.5.25"' in temp_project["pyproject"].read_text()
|
|
assert '__version__ = "0.5.25"' in temp_project["version_py"].read_text()
|
|
assert json.loads(temp_project["openclaw_pkg"].read_text())["version"] == "0.5.25"
|
|
assert json.loads(temp_project["typescript_pkg"].read_text())["version"] == "0.5.25"
|
|
assert json.loads(temp_project["claude_plugin"].read_text())["version"] == "0.8.0"
|
|
assert (
|
|
json.loads(temp_project["repo_github_marketplace"].read_text())["metadata"]["version"]
|
|
== "0.8.0"
|
|
)
|
|
assert not (root / ".releasemetadata").exists()
|
|
|
|
|
|
def test_openclaw_headroom_dependency_is_preserved_for_registry_installability(
|
|
temp_project: dict[str, Path],
|
|
) -> None:
|
|
"""Source package stays installable even when the next SDK is not on npm yet."""
|
|
root = temp_project["root"]
|
|
script = Path(__file__).parent.parent / "version-sync.py"
|
|
|
|
result = subprocess.run(
|
|
[sys.executable, str(script), "--root", str(root), "--version", "0.28.0"],
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
assert result.returncode == 0, f"Script failed: {result.stderr}"
|
|
openclaw_pkg = json.loads(temp_project["openclaw_pkg"].read_text())
|
|
assert openclaw_pkg["version"] == "0.28.0"
|
|
assert openclaw_pkg["dependencies"]["headroom-ai"] == "^0.22.3"
|