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>
174 lines
4.6 KiB
PowerShell
174 lines
4.6 KiB
PowerShell
param(
|
|
[string]$Python = "",
|
|
[switch]$CheckOnly,
|
|
[switch]$SkipRust,
|
|
[switch]$SkipNode,
|
|
[switch]$SkipDocs,
|
|
[switch]$SkipSmoke
|
|
)
|
|
|
|
$ErrorActionPreference = "Stop"
|
|
|
|
function Write-Step {
|
|
param([string]$Message)
|
|
Write-Host ""
|
|
Write-Host "==> $Message"
|
|
}
|
|
|
|
function Get-CommandPath {
|
|
param([string]$Name)
|
|
$cmd = Get-Command $Name -ErrorAction SilentlyContinue
|
|
if ($cmd) {
|
|
return $cmd.Source
|
|
}
|
|
return $null
|
|
}
|
|
|
|
function Resolve-Python {
|
|
param([string]$Requested)
|
|
|
|
if ($Requested) {
|
|
if (-not (Test-Path -LiteralPath $Requested)) {
|
|
throw "Requested Python path does not exist: $Requested"
|
|
}
|
|
return (Resolve-Path -LiteralPath $Requested).Path
|
|
}
|
|
|
|
if ($env:HEADROOM_DEV_PYTHON -and (Test-Path -LiteralPath $env:HEADROOM_DEV_PYTHON)) {
|
|
return (Resolve-Path -LiteralPath $env:HEADROOM_DEV_PYTHON).Path
|
|
}
|
|
|
|
$repoVenv = Join-Path $script:RepoRoot ".venv\Scripts\python.exe"
|
|
if (Test-Path -LiteralPath $repoVenv) {
|
|
return (Resolve-Path -LiteralPath $repoVenv).Path
|
|
}
|
|
|
|
$auditVenv = Join-Path $script:RepoRoot "..\..\.venv\Scripts\python.exe"
|
|
if (Test-Path -LiteralPath $auditVenv) {
|
|
return (Resolve-Path -LiteralPath $auditVenv).Path
|
|
}
|
|
|
|
$systemPython = Get-CommandPath "python.exe"
|
|
if (-not $systemPython) {
|
|
throw "python.exe not found. Install Python 3.10+ first."
|
|
}
|
|
|
|
Write-Step "Creating local .venv"
|
|
& $systemPython -m venv (Join-Path $script:RepoRoot ".venv")
|
|
return (Resolve-Path -LiteralPath $repoVenv).Path
|
|
}
|
|
|
|
function Ensure-Rust {
|
|
if ($SkipRust) {
|
|
return
|
|
}
|
|
|
|
$cargoBin = Join-Path $env:USERPROFILE ".cargo\bin"
|
|
if (Test-Path -LiteralPath $cargoBin) {
|
|
$env:PATH = "$cargoBin;$env:PATH"
|
|
}
|
|
|
|
if (Get-CommandPath "cargo.exe") {
|
|
return
|
|
}
|
|
|
|
$winget = Get-CommandPath "winget.exe"
|
|
if (-not $winget) {
|
|
throw "cargo.exe not found and winget.exe is unavailable. Install Rustup from https://rustup.rs/."
|
|
}
|
|
|
|
Write-Step "Installing Rustup"
|
|
& $winget install --id Rustlang.Rustup -e --silent --accept-package-agreements --accept-source-agreements
|
|
if (Test-Path -LiteralPath $cargoBin) {
|
|
$env:PATH = "$cargoBin;$env:PATH"
|
|
}
|
|
}
|
|
|
|
function Invoke-NpmCi {
|
|
param([string]$RelativePath)
|
|
|
|
if ($SkipNode) {
|
|
return
|
|
}
|
|
|
|
$npm = Get-CommandPath "npm.cmd"
|
|
if (-not $npm) {
|
|
throw "npm.cmd not found. Install Node.js 18+."
|
|
}
|
|
|
|
$dir = Join-Path $script:RepoRoot $RelativePath
|
|
if (-not (Test-Path -LiteralPath (Join-Path $dir "package-lock.json"))) {
|
|
return
|
|
}
|
|
|
|
Write-Step "npm ci in $RelativePath"
|
|
Push-Location $dir
|
|
try {
|
|
& $npm ci
|
|
}
|
|
finally {
|
|
Pop-Location
|
|
}
|
|
}
|
|
|
|
$script:RepoRoot = (Resolve-Path (Join-Path $PSScriptRoot "..")).Path
|
|
Set-Location $script:RepoRoot
|
|
|
|
$pythonExe = Resolve-Python $Python
|
|
$cargoBinPath = Join-Path $env:USERPROFILE ".cargo\bin"
|
|
if (Test-Path -LiteralPath $cargoBinPath) {
|
|
$env:PATH = "$cargoBinPath;$env:PATH"
|
|
}
|
|
|
|
Write-Step "Tool versions"
|
|
& $pythonExe --version
|
|
& $pythonExe -m pip --version
|
|
node.exe --version
|
|
npm.cmd --version
|
|
if (Get-CommandPath "cargo.exe") {
|
|
cargo.exe --version
|
|
}
|
|
|
|
if ($CheckOnly) {
|
|
exit 0
|
|
}
|
|
|
|
Ensure-Rust
|
|
|
|
Write-Step "Installing Python build/dev tools"
|
|
& $pythonExe -m pip install --upgrade pip
|
|
& $pythonExe -m pip install --upgrade `
|
|
"maturin>=1.5,<2" uv ruff mypy pre-commit pytest-cov `
|
|
opentelemetry-sdk opentelemetry-exporter-otlp-proto-http `
|
|
"tree-sitter-language-pack>=0.10.0,<1.0" "tree-sitter>=0.25.2,<0.26" `
|
|
openpyxl
|
|
|
|
Write-Step "Building native extension with maturin ci profile"
|
|
& $pythonExe -m maturin develop -m "crates\headroom-py\Cargo.toml" --profile ci
|
|
|
|
Write-Step "Installing runtime extras without rebuilding headroom-ai"
|
|
& $pythonExe -m pip install --upgrade `
|
|
"tree-sitter-language-pack>=0.10.0,<1.0" `
|
|
anthropic ollama langchain-ollama hnswlib `
|
|
"sentence-transformers>=2.2.0,<6.0" fastembed jinja2 xlrd
|
|
|
|
Invoke-NpmCi "sdk\typescript"
|
|
Invoke-NpmCi "plugins\openclaw"
|
|
if (-not $SkipDocs) {
|
|
Invoke-NpmCi "docs"
|
|
}
|
|
|
|
if (-not $SkipSmoke) {
|
|
Write-Step "Smoke checks"
|
|
& $pythonExe -c "import importlib.util, headroom; assert importlib.util.find_spec('headroom._core'); print(headroom.__version__)"
|
|
& $pythonExe -m headroom.cli --version
|
|
& $pythonExe -m pip check
|
|
Push-Location (Join-Path $script:RepoRoot "sdk\typescript")
|
|
try { npm.cmd run build } finally { Pop-Location }
|
|
Push-Location (Join-Path $script:RepoRoot "plugins\openclaw")
|
|
try { npm.cmd run build } finally { Pop-Location }
|
|
}
|
|
|
|
Write-Host ""
|
|
Write-Host "Headroom Windows dev environment is ready."
|