Skip to content

Update README for current capabilities#47

Merged
blackms merged 4 commits into
mainfrom
codex/update-readme-current-capabilities
May 29, 2026
Merged

Update README for current capabilities#47
blackms merged 4 commits into
mainfrom
codex/update-readme-current-capabilities

Conversation

@blackms
Copy link
Copy Markdown
Owner

@blackms blackms commented May 29, 2026

Summary

  • refresh README positioning, feature matrix, docs links, config sample, examples, project structure, and CI/CD section for the current 1.6.1 capabilities
  • export review-loop and HITL interrupt APIs from the root package so README examples use public imports that typecheck
  • stabilize consensus expiry tests by setting expiry timestamps directly instead of racing a 1ms timeout

CI investigation

The latest main CI run is green: https://github.com/blackms/aistack/actions/runs/26638216999.
The older red run was a stale Coverage failure in tests/unit/consensus-service.test.ts: the non-pending expiry test used a real 1ms timeout, so approval could race with expiry under load. This PR makes that test deterministic.

Verification

  • npm run test:unit -- tests/unit/readme-positioning.test.ts
  • npm run test:unit -- tests/unit/consensus-service.test.ts
  • npm run typecheck
  • npm run build
  • npm run test:integration
  • npm run lint (warnings only)
  • npm test

Summary by CodeRabbit

  • New Features

    • Human-In-The-Loop (HITL) interrupts, A2A protocol interop, multi-tenancy/workspace controls, sandboxed code execution, background runner/webhooks, issue-to-PR automation, and on‑prem deployment packaging
    • Enterprise SSO and SCIM provisioning support
  • Documentation

    • Expanded README and docs index with guides for HITL, A2A, daemon/webhooks, durable execution, multitenancy, sandboxing, security/SSO, and workflow DSL; updated examples and config version to v1.6.1
  • Tests

    • Made checkpoint expiration tests deterministic by simulating expired timestamps instead of waiting asynchronously

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

Warning

Review limit reached

@blackms, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 6 minutes and 15 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b1c4167c-2fa2-4030-a893-d15a520cae0b

📥 Commits

Reviewing files that changed from the base of the PR and between 9bfa588 and 2755988.

📒 Files selected for processing (2)
  • README.md
  • src/index.ts
📝 Walkthrough

Walkthrough

This PR updates README and release metadata for v1.6.1 (new feature docs, config, examples, project structure, CI), expands coordination barrel exports to expose review-loop and interrupt APIs/types, and refactors consensus-service expiration tests for deterministic behavior.

Changes

v1.6.1 Release Package

Layer / File(s) Summary
Feature Documentation & Configuration
README.md
README sections describing v1.6.1: capability summary, "what it does", audience, feature subsections (HITL interrupts, A2A, sandboxed execution, daemon/webhooks, multi-tenancy, issue-to-PR automation, security/SSO), updated configuration JSON with daemon/a2a/multitenancy/sandbox/github blocks, usage examples (HITL, A2A, daemon, issue→PR), project structure additions, deployment artifacts (charts/Docker), CI/CD pipeline rewrite, exclusions, and version badge bump to v1.6.1.
Coordination API Surface
src/coordination/index.ts, src/index.ts
Root barrel exports expanded to surface review-loop coordination APIs (ReviewLoopCoordinator, createReviewLoop, getReviewLoop, listReviewLoops, abortReviewLoop, clearReviewLoops) and interrupt control/runtime APIs (interrupt, applyStateEdit, getInterruptStore, resetInterruptStore, setInterruptPersistence, resumeInterrupt, resumeLatestForSession) plus related exported types and errors.
Test Determinism
tests/unit/consensus-service.test.ts
expireCheckpoints tests refactored to backdate expires_at directly and assert behavior immediately, removing timing-dependent waits to ensure deterministic test outcomes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • blackms/aistack#33: Overlaps at the interrupt primitive implementation and types that this PR re-exports from coordination.
  • blackms/aistack#1: Related to review-loop implementation that the root barrel now exposes via src/index.ts.

Poem

🐰 In v1.6.1 I hop and peep,

Pauses hold, A2A talks deep,
Tenants nest in sandboxed lairs,
Daemons hum and docs declare,
Tests tic-tock no more—sleep sweet.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Update README for current capabilities' directly and clearly summarizes the main change—refreshing the README to reflect v1.6.1 capabilities. It is concise and specific enough for a teammate to understand the primary focus of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/update-readme-current-capabilities

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
README.md (1)

515-533: 💤 Low value

Daemon webhook and A2A share the same default port (8787).

daemon.webhook.port and a2a.port both default to 8787. They're disabled by default so there's no immediate conflict, but enabling both as documented would collide. Consider using distinct sample ports to avoid confusing readers who copy this config.

📝 Suggested tweak
   "a2a": {
     "enabled": false,
-    "port": 8787,
+    "port": 8788,
     "host": "127.0.0.1",
-    "publicUrl": "http://127.0.0.1:8787",
+    "publicUrl": "http://127.0.0.1:8788",
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 515 - 533, The README sample uses the same default
port for daemon.webhook.port and a2a.port (both 8787), which will collide when
both are enabled; update the example so these identifiers use distinct sample
ports (e.g., keep daemon.webhook.port at 8787 and change a2a.port and
a2a.publicUrl to a different port like 8788) and ensure the related
a2a.publicUrl value is updated to match the new a2a.port to keep the example
consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Around line 515-533: The README sample uses the same default port for
daemon.webhook.port and a2a.port (both 8787), which will collide when both are
enabled; update the example so these identifiers use distinct sample ports
(e.g., keep daemon.webhook.port at 8787 and change a2a.port and a2a.publicUrl to
a different port like 8788) and ensure the related a2a.publicUrl value is
updated to match the new a2a.port to keep the example consistent.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 08fc8020-0b6c-47b1-8d60-71fc43fd0cdd

📥 Commits

Reviewing files that changed from the base of the PR and between f096996 and dc6c6f8.

📒 Files selected for processing (4)
  • README.md
  • src/coordination/index.ts
  • src/index.ts
  • tests/unit/consensus-service.test.ts

@blackms blackms merged commit 54597ac into main May 29, 2026
6 checks passed
@blackms blackms deleted the codex/update-readme-current-capabilities branch May 29, 2026 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant