Commit Graph
13 Commits
Author SHA1 Message Date
66e1467682 feat(plugins): headroom skill for Claude Code, Codex, Copilot and skills.sh (#4533)
## Description

In the unbranded sandbox run the agent never searched and wrote a
300-line trimmer by hand; nothing in its environment said Headroom
exists. An Agent Skill is the one artifact that fires on the job words
(cut input tokens, trim tool outputs, fit a context window) with zero
fetches. Four unofficial "headroom" skills already exist on skills.sh;
there is no official one.

Depends on #4529 for the `/docs/fastapi` link in the skill body.

## Type of Change

- [x] New feature (non-breaking change that adds functionality)

## Changes Made

- `skills/headroom/SKILL.md`: job-language description; body is the
no-key `compress()` path, the zero-network check, `model_limit` /
`protect_recent`, the TypeScript proxy caveat, the coding-agent path,
and a short do-not list (no savings claims, no `CompressionMiddleware`
for apps that call a provider, no `[all]` unless asked).
- `plugins/headroom-skill/`: the same SKILL.md under `skills/`,
`.claude-plugin/plugin.json` and `.github/plugin/plugin.json`
(identical), README with install lines for Claude Code, Copilot CLI and
`npx skills add`.
- Both marketplace manifests: `headroom-skill` entry, inserted after the
hooks plugin so `plugins[0]` stays as the existing tests expect.
- `scripts/version-sync.py` and `scripts/verify-versions.py`: the two
new manifests, so the next release PR passes the version gate.
`scripts/tests/test_version_sync.py` fixture and assertion extended;
`tests/test_release_workflows.py` gate list extended.
- `tests/test_plugin_manifests.py`: the two SKILL.md copies must be
byte-identical (the repo has no symlinks, for Windows checkouts),
frontmatter has `name: headroom`; the skill plugin's two manifests match
each other and the marketplace entry.

## Testing

- [x] Unit tests pass: `tests/test_plugin_manifests.py
scripts/tests/test_version_sync.py tests/test_release_workflows.py -k
"manifest or version or skill or sync"`: 30 passed
- [x] `ruff check` / `ruff format --check` on the touched Python
- [x] `python scripts/verify-versions.py`: "All versions aligned at
0.42.0"
- [x] Manual testing performed

### Test Output

```text
pytest tests/test_plugin_manifests.py scripts/tests/test_version_sync.py tests/test_release_workflows.py -k "manifest or version or skill or sync": 30 passed
python scripts/verify-versions.py: All versions aligned at 0.42.0
claude plugin validate .: ✔ Validation passed
```

## Real Behavior Proof

- Environment: macOS arm64, Claude Code CLI.
- Exact command / steps: `claude plugin validate .` at the repo root of
this branch.
- Observed result: `✔ Validation passed`. The only warning is
pre-existing and about `plugins/headroom-agent-hooks/README.md` lacking
a marketplace install line.
- Not tested: installing the plugin from the marketplace into a fresh
Claude Code or Copilot CLI session and triggering the skill on a real
task; skills.sh indexing (happens on their side once this is on `main`).

## Runtime Rollout Safety

- Rollout-managed feature(s): none; documentation and metadata only, no
runtime code path changes
- Minimum rollout channel: n/a
- Stable/default behavior changed: no
- Kill switch / disable path: n/a (revert the PR)
- Unsafe override required: no
- Qualification impact: none
- Rollback path: revert the commit

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-11-03 23:43:21 -06:00
JD Davis 3f990663cc fix(release): synchronize editable uv lock version (#4054)
## Description

Full version synchronization changes pyproject.toml but previously left
the editable root package version in uv.lock unchanged. Locked uv
installs then reject regenerated release branches. #4002 demonstrated
this again when release-please regenerated from main and discarded its
manual lock repair and automation commit.

Move the durable automation repair into main through this dedicated PR.
Release-please can inherit it after merge rather than repeatedly
dropping a change made only on its generated branch. Current commit:
f61cd097d (comment punctuation follow-up; functional code unchanged).

## Type of Change

- [x] Bug fix (release lock synchronization)

## Changes Made

- Update exactly the editable source="." root package's version during
full version synchronization.
- Preserve all third-party lock entries without resolving dependencies.
- Keep plugin-only synchronization from touching Python/lock metadata.
- Add a byte-preservation regression with a third-party package sharing
the old version.

## Testing

- [x] 81 focused version-sync/release-version/release-workflow tests
passed on current main 17abee272.
- [x] Scoped Ruff lint, format and whitespace checks passed.
- [x] Actual full-sync CLI and uv locked-check replay passed.

```text
81 passed in 5.42s
All checks passed!
2 files already formatted
```

The regression's original red/green evidence is retained from #4002:
full sync left the editable root at 0.5.25 before repair and correctly
updated it to 0.7.0 after repair while same-version third-party bytes
remained unchanged. Plugin-only control passes.

## Real Behavior Proof

- Environment: Windows, current-main checkout with the actual uv.lock,
uv and the real scripts/version-sync.py command. No dependency resolver
substitution.
- Exact command / steps: Run python
G:/git/headroom/.remember/tmp/resume36-lock-sync-runtime.py.
Independently replace only the editable headroom-ai root version with
0.0.0 while project metadata stays 0.40.0; run uv lock --check; run
python scripts/version-sync.py; rerun uv lock --check and compare the
full lock bytes to the original.
- Observed result: The stale root was rejected; full CLI synchronization
repaired it; the locked check passed and every lock byte matched the
original. Existing generated Windows manifest newline noise was restored
before publication; only script/tests change.
- Not tested: Full locked environment installation, release/tag
creation, npm/PyPI publication or external rollout. Exact-head hosted
checks are terminal: 52 successes, 16 intended skips, and 46
duplicate-run cancellations; successful matching workflow runs are
verified below. The repair takes effect for release-please regeneration
only after this PR reaches main.

```text
PASS red: actual uv lock --check rejects stale editable root
Version synchronized to 0.40.0
PASS green: full CLI sync repairs root; uv lock --check passes; complete lock bytes match original
```

## Runtime Rollout Safety

- Rollout-managed feature(s): Release metadata only; no runtime feature.
- Minimum rollout channel: No new channel requirement.
- Stable/default behavior changed: Full version-sync now aligns the
editable uv.lock root; dependencies and plugin-only synchronization
retain their existing behavior.
- Kill switch / disable path: Do not invoke version synchronization; no
runtime toggle applies.
- Unsafe override required: No.
- Qualification impact: Local metadata checks cover the two-file repair.
Release packaging/publication remains separately gated.
- Rollback path: Revert this script/test change, restoring the known
stale-lock limitation.

## Review Readiness

- [x] I have performed a self-review
- [x] This PR is ready for human review

Independent review is required. No merge, release, publication or
self-approval performed.


Exact-head qualification for f61cd097d7:
all checks are terminal, with 52 successes and 16 intended skips. The
remaining 46 cancelled checks belong to duplicate runs of the same SHA;
corresponding complete successful workflow runs exist. Verified
successful runs: CI 37838252441, Security 37838252409, rust 37838252460,
Release 37838252963, Merge Conflicts 37838252937, Changelog Guard
37838252468 and PR Governance 37838907358. No failed or live checks
remain. The sole review thread is resolved.

The local full-sync/uv locked-check and byte-preservation proof remains
applicable; the last commit only repairs comment punctuation. This
provides the durable main-branch repair that #4002's generated release
branch still lacks. Release-please cannot inherit it until this PR
merges; future regeneration may discard #4002's manual repair before
then. Independent review is still required. No merge, self-approval,
release or publication performed.
2026-10-08 22:37:38 -05:00
17abee2721 feat(plugins): add headroom-snip Claude Code mod that animates compression (#3980)
## Description

Adds `headroom-snip`, a Claude Code plugin that shows what Headroom does
to each request while you work. Headroom's savings are mostly invisible
from inside Claude Code; this puts them right above the prompt.

- **Band above the prompt:** for each new request through the proxy, a
scissors animation cuts a bar the size of the original prompt down to
what was sent (`21k → 4.1k tok −81%`). It names the compressors that did
the cutting (JSON crush, code AST, Kompress text, log squash, cache
align, …) and the running total since the session started. When a
request goes through unchanged it says why (for example `kept: user
message, recent code`).
- **`/headroom`:** opens a pane with the per-request log since the
session started: bar, what was cut and what was kept, compression
latency, biggest snip, all-time total. `/headroom hide` and `/headroom
show` toggle the band.
- **Status line** running total, and toasts at savings milestones.
- If the proxy isn't reachable, the band says so and suggests `headroom
wrap claude`.

It reads the proxy's existing loopback `GET /stats?cached=1`
(`recent_requests`), polling once a second only while a turn runs and
for a few seconds after. Requests stamped before the session started are
not counted. Under `headroom wrap claude` (which sends
`X-Headroom-Project`), only requests the proxy tagged with this
session's project count, and the totals are labelled as that project's
traffic since the session started (the tag is the launch directory's
basename, so other sessions in the same project are included); otherwise
they are labelled proxy-wide. There is no per-session request identity
at the proxy, so nothing is labelled as a per-session total. No proxy
changes; nothing leaves the machine. Proxy URL: `HEADROOM_PROXY_URL`,
else `ANTHROPIC_BASE_URL`, else `http://127.0.0.1:8787`. Each candidate
must be a loopback URL (http or https on exactly `localhost`,
`127.0.0.1` or `[::1]`, no userinfo); anything else is skipped, so the
plugin never polls a remote host.

## Spec

**API surface:** a Claude Code plugin (`headroom-snip` in
`.claude-plugin/marketplace.json`). The `/headroom` command, with `hide`
and `show`. Reads the `HEADROOM_PROXY_URL`, `ANTHROPIC_BASE_URL` and
`ANTHROPIC_CUSTOM_HEADERS` environment variables. No proxy, CLI or
library changes.

**Changes to existing behavior:** none. The `headroom` plugin and the
Copilot marketplace are untouched.

**User stories:**
- *Golden path.* Given Claude Code launched with `headroom wrap claude`
and the plugin installed, when a turn sends a request the proxy
compresses, then within about a second the band animates that request's
original → sent tokens and names the compressors, and `/headroom` lists
it newest first.
- *Edge case: proxy not running.* Given the plugin is installed but
nothing answers at the proxy URL, when a turn runs, then the band says
Headroom isn't in the loop and suggests `headroom wrap claude`, and
nothing else changes.
- *Edge case: shared proxy.* Given two clients on one proxy, when the
other client sends a request, then a wrapped session leaves it out
(different project tag), and an unwrapped session counts it but labels
its totals "proxy".
- *Edge case: two sessions in one project.* Given two wrapped Claude
Code sessions launched from directories with the same name, when either
sends a request, then both sessions count it, and the band says
"project" and the pane and toasts name the project, never "session".

**Failure modes:** proxy down or slow (the band shows the not-running
message, and requests are recovered when it comes up); a malformed
`/stats` body (ignored); a non-loopback proxy URL (skipped, falls back
to the default); a request without a timestamp (counted only if it
appears after the first successful poll).

**Recovery / resilience:** no state outside Claude Code; running totals
live in plugin state and survive a plugin reload. Disable with `claude
plugin disable headroom-snip@headroom-marketplace`.

**Security considerations:** see Additional Notes.

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- `plugins/headroom-snip/`: the plugin (`hooks/register.tsx` for hooks
and drawing, `hooks/snip.ts` for parsing, the loopback URL policy,
transform labels and animation frames), its state types, tests and
README.
- `.claude-plugin/marketplace.json`: lists `headroom-snip`, installable
with `claude plugin install headroom-snip@headroom-marketplace`. It is
**not** added to `.github/plugin/marketplace.json`, because Copilot CLI
can't load Claude Code function hooks.
- `tests/test_plugin_manifests.py`: the two marketplaces must still
match apart from Claude-Code-only plugins. A new test checks each such
plugin's manifest name, version and `hooks/hooks.json`.
- `scripts/version-sync.py`, `scripts/verify-versions.py`: the new
`plugin.json` version is synced and verified with the rest (0.39.1).
- `scripts/tests/test_version_sync.py`: fixture and assertion for the
new manifest.

## Testing

- [x] Unit tests pass (`pytest`): the manifest and version-sync tests
touched here
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`): N/A, no changes under
`headroom/`
- [x] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
$ pytest -q tests/test_plugin_manifests.py scripts/tests/test_version_sync.py
16 passed, 1 warning in 0.60s

$ ruff check tests/test_plugin_manifests.py scripts/
All checks passed!
$ ruff format --check tests/test_plugin_manifests.py scripts/
27 files already formatted

$ python scripts/verify-versions.py
All versions aligned at 0.39.1

$ claude plugin validate plugins/headroom-snip
✔ Validation passed

$ claude plugin test plugins/headroom-snip
(pass) proxy url follows the wrapped base url only when it is local
(pass) valid loopback urls keep their origin
(pass) hosts that only look local are never polled
(pass) userinfo, other schemes and junk are refused even on loopback
(pass) a remote override falls back to the local base url, not the remote host
(pass) transforms read as plain words
(pass) the finished bar keeps the sent share and dusts the rest
(pass) rows come back oldest first, with their project tags
(pass) the session project is read from the wrapped custom headers
(pass) a request is this session's by its stamp and project
(pass) every milestone a step crosses is announced, lowest first
(pass) a request made during a turn is snipped in the band
(pass) two new requests in one poll show the newest in the band and newest first in the pane
(pass) a proxy that comes up after the session started still counts the session's requests
(pass) with a project header, other clients on the proxy are left out
(pass) two sessions in one project share a count, and every label says project, not session
(pass) one big snip announces each milestone it crosses
(pass) polling picks up a request that lands just after the turn, then stops
 18 pass
 0 fail
```

The plugin tests are a bun-style suite run by `claude plugin test`. They
fake the proxy's `/stats` response (newest first, as the proxy sends it)
and check what the band and the `/headroom` pane draw: original → sent
figures, percentages, compressor labels, totals and their project/proxy
label (including two sessions sharing one project tag), newest-first
ordering when one poll brings several requests, a proxy that comes up
mid-session, filtering by project tag, a toast for each milestone
crossed, polling that continues briefly after a turn and then stops, the
hide button and the no-proxy message. Each of the four review fixes was
checked by restoring the old behaviour: its tests fail. The plugin also
type-checks clean under `tsc` against Claude Code's plugin API types
(strict, `noUncheckedIndexedAccess`).

## Real Behavior Proof

- Environment: macOS, iTerm2, Claude Code 2.1.289, local Headroom proxy
- Exact command / steps: `headroom wrap claude --plugin-dir
plugins/headroom-snip`, then ran prompts that read large tool output
(`ls -la /usr/lib`, `cat package-lock.json`), then ran `/headroom`
- Observed result: the band animated the snip for each compressed
request with original → sent tokens and compressor labels; `/headroom`
listed the requests since the session started
- Not tested: Claude desktop app and VS Code surfaces against a live
proxy (covered only by the `desktop` surface in the plugin tests);
terminals other than iTerm2

## Runtime Rollout Safety

- Rollout-managed feature(s): none. This is an opt-in Claude Code
plugin; nothing in the proxy or `headroom` package changes.
- Minimum rollout channel: N/A. It reaches only users who run `claude
plugin install headroom-snip@headroom-marketplace`.
- Stable/default behavior changed: no. Existing installs, the `headroom`
plugin and the Copilot marketplace are unchanged.
- Kill switch / disable path: `claude plugin disable
headroom-snip@headroom-marketplace` (or `uninstall`); `/headroom hide`
hides the band.
- Unsafe override required: no.
- Qualification impact: none on proxy compression or latency. The plugin
makes one cached loopback `GET /stats?cached=1` per second while a turn
runs.
- Rollback path: revert this PR, which removes the plugin and its
marketplace entry; installed copies can be uninstalled as above.

## Review Readiness

- [x] I 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 own code
- [x] 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: N/A, release-please
generates it from the PR title

## Additional Notes

- **Security considerations:** read-only. The plugin only sends `GET`
requests to the proxy's existing loopback `/stats` endpoint, which
already returns per-request metadata only to loopback callers. Proxy
URLs are parsed and must name exactly `localhost`, `127.0.0.1` or
`[::1]` over http(s) with no userinfo; look-alike hosts
(`localhost.example.com`, `127.0.0.1.example.com`,
`localhost@example.com`) and remote overrides are refused, with
regression tests. It sends no data elsewhere and changes nothing in the
proxy.
- Follow-up idea, not in this PR: a pixel-art mascot, and showing when
Claude retrieves stashed originals (CCR, `/v1/retrieve/stats`) as
visible proof that nothing cut is lost.

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
2026-10-08 14:22:21 -05:00
Rod BoevandJD Davis 78591545ce fix: publish headroom-opencode in release workflow (#2372)
## Description

`headroom-opencode` is documented as an npm package, but the release
workflow never published it, so installs failed with a registry 404 even
though the plugin source already lived under `plugins/opencode`. This
wires the existing package into the npm release path, keeps its version
synced with root releases, and adds release guards for the new package.
Closes #76.

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- added `headroom-opencode` to the npm release workflow, including
release-version stamping and `headroom-ai` dependency rewrite before
publish
- added `plugins/opencode/package.json` to release-please and local
version-sync guards
- synced the source opencode package version to the current release line
and documented the new npm package in the release docs
- added focused release workflow and version-sync tests for the opencode
package
- aligned the two failing dashboard Playwright tests with the current
Session/Lifetime split and `/stats-lifetime` fixture contract

## Testing

- [x] Unit tests pass (`uv run pytest scripts/tests/test_version_sync.py
-q`, `uv run pytest tests/test_release_workflows.py -q -k
'publish_npm_rewrites_opencode_dependency_after_version_and_before_publish
or opencode_source_dependency_matches_lockfile_registry_range or
release_please_manifest_config_consistency'`)
- [x] Unit tests pass (`uv run pytest
tests/test_dashboard_cache_lifetime_playwright.py
tests/test_dashboard_cache_ttl_playwright.py -q`)
- [x] Linting passes (`uv run ruff check scripts/verify-versions.py
scripts/version-sync.py scripts/tests/test_version_sync.py
tests/test_release_workflows.py`)
- [ ] Type checking passes (`uv run mypy headroom`)
- [x] New tests added for new functionality when applicable
- [x] Manual testing performed

### Test Output

```text
$ uv run pytest scripts/tests/test_version_sync.py -q
8 passed, 1 warning in 0.51s

$ uv run pytest tests/test_release_workflows.py -q -k 'publish_npm_rewrites_opencode_dependency_after_version_and_before_publish or opencode_source_dependency_matches_lockfile_registry_range or release_please_manifest_config_consistency'
2 passed, 38 deselected, 1 warning in 0.07s

$ uv run pytest tests/test_dashboard_cache_lifetime_playwright.py tests/test_dashboard_cache_ttl_playwright.py -q
4 passed, 1 warning in 4.04s

$ uv run ruff check scripts/verify-versions.py scripts/version-sync.py scripts/tests/test_version_sync.py tests/test_release_workflows.py
All checks passed!

$ npm ci && npm run build  (plugins/opencode)
Build success; dist/index.js, dist/entry.opencode.js, and DTS outputs emitted
```

## Real Behavior Proof

- Environment: Windows, Python 3.11.15, Node v24.15.0, npm 11.16.0
- Exact command / steps: inspected `.github/workflows/release.yml`,
updated the npm publish path for `plugins/opencode`, aligned the two
failing dashboard Playwright tests with the current Session/Lifetime
split, then ran the focused pytest commands above plus `npm ci && npm
run build` in `plugins/opencode`
- Observed result: the release workflow now versions and publishes
`headroom-opencode`, release-please and version-sync track
`plugins/opencode/package.json`, the dashboard tests now fetch durable
cache and setup-url data from the Lifetime view, and the opencode
package still builds locally from source
- Not tested: GitHub Package Registry publish

## 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
- [x] 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
- [x] I have updated the CHANGELOG.md if applicable

## Additional Notes

`CHANGELOG.md` is unchanged because release-please owns changelog
generation here.

---------

Co-authored-by: JD Davis <mxjerrett@gmail.com>
2026-08-11 23:56:40 -05:00
Tejas Chopra 5383c6bf2f fix(release): sync generated version metadata on the release branch (#2659)
## Description

The 0.33.0 release PR (#2339) has sat in `changes-requested` since
2026-07-17. Root cause: **release-please only rewrites `pyproject.toml`
and its configured `extra-files`**, but other tracked files also carry
the version — and `server.json` is asserted byte-for-byte against
`render_server_json()`, which derives its version from `pyproject.toml`.
So the bump alone fails
`tests/test_mcp_registry/test_server_json.py::test_root_server_json_matches_builder`
(the `test (2)` shard) on every regenerated release PR.

Nothing in the repo regenerated `server.json` at all, so it fell behind
every release.

Unblocks #2339.

### Why the release *build* passes but the release PR does not

`release.yml` already runs `scripts/version-sync.py` immediately before
its own `verify-versions.py` gate (lines 145 and 278). That is why
`build` and `build-wheels` are green on #2339 despite the drift — it
syncs in the workspace, uncommitted. The regular CI test job does
**not** sync, so the fix has to be committed to the branch.

This also explains why reviewers kept seeing `verify-versions.py` fail
locally while CI's build jobs passed: the verifier is never run
un-synced inside `release.yml`.

## Type of Change

- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)

## Changes Made

- **`scripts/version-sync.py`**: also write `server.json`. It was the
one version-carrying file with no writer anywhere. Values are rewritten
in place so key order and formatting keep matching the builder's
byte-for-byte output (verified: the file is pure ASCII and round-trips
exactly through `json.dumps(..., indent=2) + "\n"`).
- **`.github/workflows/release-metadata-sync.yml`** (new): on a push to
`release-please--branches--**`, run version-sync → gate on
verify-versions → commit if changed.
- **Keyed off the branch push** because release-please force-regenerates
that branch on every merge to main. That is precisely what wiped the
hand-pushed metadata fixes on #2339 (`2a86c8ff`, `d5ea4dc5`) — a push
trigger re-heals after every regeneration instead of being lost.
- **Uses the same PAT as `release-please.yml`**: a `GITHUB_TOKEN` push
does not trigger workflows, so the release PR's checks would never
re-run against the synced commit and would stay red.
- **Idempotent**: the self-triggered rerun finds no diff and exits
before pushing, so the loop terminates after one no-op run.
- **Corrected pre-existing drift on `main`**: the agent-hooks plugin
manifests, both marketplace manifests, and `.releasemetadata` were
stranded at **0.31.0** — never bumped for 0.32.0 either.
`verify-versions.py` now passes on `main`.

### Why not more `extra-files` entries

That would need ~13 jsonpath entries restating what `version-sync.py`
already knows, and a jsonpath that fails to match **fails silently** —
the same class of failure this PR removes, discoverable only after a
real release PR regenerates. There is also no precedent for nested
jsonpath (`$.packages[0].version`, `$.metadata.version`) in the config
today; both existing entries are plain `$.version`. Running the script
keeps one source of truth, and files added to it later are covered with
no change here.

## Testing

- [x] Unit tests pass (`pytest`)
- [x] Linting passes (`ruff check .`)
- [ ] Type checking passes (`mypy headroom`) — no `headroom/` sources
touched
- [x] New tests added for new functionality
- [x] Manual testing performed

### Test Output

```text
$ python -m pytest scripts/tests/ tests/test_release_workflows.py tests/test_mcp_registry/ -q
207 passed in 2.69s

$ ruff check scripts/version-sync.py scripts/tests/test_version_sync.py tests/test_release_workflows.py
All checks passed!
$ ruff format --check <same>
3 files already formatted

$ actionlint .github/workflows/release-metadata-sync.yml
(clean)
```

New tests:
- `test_server_json_version_is_synchronized` — version-sync moves both
`server.json` version fields and preserves the other keys.
- `test_release_metadata_sync_runs_on_release_please_branch` — asserts
the trigger, the sync→verify→commit ordering, the no-op guard, and the
PAT.
- `test_version_sync_covers_every_file_the_verifier_gates` — guards
`version-sync.py` and `verify-versions.py` against drifting apart again,
which is the root cause here.

## Real Behavior Proof

- **Environment:** macOS (Darwin arm64), Python 3.12, repo venv.
- **Exact command / steps:** reproduced the CI failure locally by
simulating release-please's partial bump, then applying the fix.

**Reproducing the exact `test (2)` failure** — set `pyproject` to 0.33.0
while `server.json` stays at 0.32.0, as release-please leaves it:

```text
$ python -m pytest tests/test_mcp_registry/test_server_json.py -q
FAILED tests/test_mcp_registry/test_server_json.py::test_root_server_json_matches_builder
1 failed, 3 passed
```

**After `version-sync.py`:**

```text
$ python scripts/version-sync.py && python -m pytest tests/test_mcp_registry/test_server_json.py -q
4 passed
```

**Both gates green on a simulated 0.33.0 bump:**

```text
$ python scripts/version-sync.py --version 0.33.0
Version synchronized to 0.33.0
$ python scripts/verify-versions.py
All versions aligned at 0.33.0
$ python -m pytest tests/test_mcp_registry/test_server_json.py -q
4 passed
```

**Idempotency** (the property the workflow's loop-termination relies
on): re-running against an already-synced tree leaves `pyproject.toml`,
`server.json`, `openclaw`, and `sdk/typescript` untouched.

- **Not tested:** the workflow has not executed on a real release-please
branch regeneration — that can only be exercised once this is on `main`
and release-please next updates #2339. The PAT push path and the
self-trigger no-op are reasoned from `release-please.yml`'s existing
token comment and from local idempotency, not observed in CI.

## 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
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] 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
- [x] I did **not** edit `CHANGELOG.md`

## Additional Notes

**Context on the v0.32.0 release failure, since it is easy to misread as
"images never build".** Every artifact built for v0.32.0 — all 5 wheel
platforms including Windows, all 16 Docker builds + 8 manifests +
`promote-latest`, npm, and GitHub Packages. Only `publish-pypi` failed
(PyPI attestations, already fixed by `f9cbdd6e` / #2405), and
`create-release` was skipped because it depends on it. That is why the
release looked like it produced nothing.

**Separate, approaching blocker — not addressed here.** PyPI is at
**9.69 GB of its 10 GB project cap (96.9%)**, leaving ~305 MB against
~68 MB per release, so roughly 4 more releases fit. The `0.21.x` series
alone holds **6.58 GB across 31 releases**, from the old
every-push-is-a-release era; pruning it would reclaim two thirds of the
quota. Worth a separate issue.

**`.releasemetadata` is written but never read** by anything outside
`version-sync.py` and its test. It is kept in sync here for internal
consistency, but it may be a deletion candidate.
2026-07-29 15:12:04 -07:00
5709291914 chore(release): harden local artifact smokes (#1824)
## 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>
2026-07-14 16:07:34 -04:00
Sepuri Sai Krishna 772adc93b2 fix(scripts): rename .releaseetadata to .releasemetadata (#1246)
## Description
  
Fixes a typo in the release metadata filename written by
`scripts/version-sync.py`.
The file was being created as `.releaseetadata` (double `e`) instead of
`.releasemetadata`.
Any downstream tooling or developer looking for the artifact by its
correct name would not find it.

  Closes #

  ## Type of Change

  - [x] Bug fix (non-breaking change that fixes an issue)
  - [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
  - [ ] Documentation update
  - [ ] Performance improvement 
  - [ ] Code refactoring (no functional changes)

  ## Changes Made

- `scripts/version-sync.py`: corrected the filename in
`write_release_metadata()` — both the docstring and the `metadata_path`
assignment.
- `scripts/tests/test_version_sync.py`: updated 3 test assertions to
reference `.releasemetadata`.

  ## Testing

  - [x] Unit tests pass (`pytest`)
  - [ ] Linting passes (`ruff check .`)
  - [ ] Type checking passes (`mypy headroom`)
  - [ ] New tests added for new functionality
  - [ ] Manual testing performed

  ### Test Output

  ```text   
  $ uv run python -m pytest scripts/tests/test_version_sync.py -q
============================= test session starts
==============================
  platform linux -- Python 3.14.0, pytest-9.1.1, pluggy-1.6.0
  rootdir: /home/sepurisaikrishna/Documents/calude-here/headroom
  configfile: pyproject.toml
  collected 6 items
  
scripts/tests/test_version_sync.py ...... [100%]

=============================== warnings summary
===============================
  PytestConfigWarning: Unknown config option: asyncio_mode

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
========================= 6 passed, 1 warning in 1.00s
=========================

  $ git diff --check origin/main..HEAD
  # no output; command exited 0
 ```

  ## Real Behavior Proof

- Environment: Linux, Python 3.14.0, uv-managed .venv, branch based on
current origin/main.
- Exact command / steps: grep -r "releaseetadata" scripts/ before the
fix returns hits; after the fix returns nothing. Confirmed
.releasemetadata is written correctly by
  test_release_metadata_written.
- Observed result: all 6 test_version_sync.py tests pass with the
corrected filename.
- Not tested: full repository pytest, ruff, and mypy — this is a
one-line spelling fix with no logic changes.

  ## 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
  - [ ] I have made corresponding changes to the documentation
  - [x] My changes generate no new warnings
- [ ] 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 typo was consistent across implementation and tests, so all tests
passed before this fix with the wrong name. The fix corrects both the
code and the test expectations together.
- No production behaviour changes the file is written but not yet
consumed by any workflow step.
2026-07-09 17:29:17 -05:00
Tejas Chopra ea1f608e79 fix: make proxy upgrades version-aware
Derive source-tree versions from release history so headroom --version no longer reports stale project metadata.

Restart stale idle proxies after an upgrade, but leave active sessions running to avoid interrupting ongoing conversations.

Remove _version.py from version-sync ownership and make version verification catch package/plugin manifest drift.
2026-05-09 15:58:27 -07:00
JerrettDavisandCopilot 56f6307665 fix: support py310 version sync scripts
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-21 20:42:56 -05:00
JerrettDavisandCopilot b852460af9 chore: normalize line endings in init diffs
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-21 20:17:14 -05:00
JerrettDavisandCopilot c5d795c2af build: sync agent hook manifests to repo semver
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-21 20:03:14 -05:00
JerrettDavisandClaude Opus 4.6 bc49e6da16 fix: build TypeScript packages, add OIDC permission, sync SDK dep, scope GPR publish
- publish-pypi: add permissions: id-token: write for OIDC trusted publishing
- publish-npm: add npm run build before npm publish for both packages
- publish-github-packages: add npm run build, use --registry for GPR
- version-sync: add update_openclaw_package_json to sync headroom-ai dep range

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-15 22:09:05 -05:00
JerrettDavis 93af60ac31 feat: add version synchronization script for multi-package releases 2026-04-15 19:29:15 -05:00