Skip to content

Commit 970d4fd

Browse files
author
Mark Pollack
committed
Update README with versioning policy and 0.12.0-SNAPSHOT release notes
Add honest versioning section: SDK tracks evolving protocol, strict semver does not apply, breaking changes documented, @UnstableAcpApi marks most volatile surface. Add 0.12.0-SNAPSHOT release notes listing new stable and unstable methods. Update test counts.
1 parent 816c2af commit 970d4fd

1 file changed

Lines changed: 32 additions & 12 deletions

File tree

README.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ agent.start().block(); // Starts WebSocket server on port 8080
387387

388388
```bash
389389
./mvnw compile # Compile
390-
./mvnw test # Run unit tests (258 tests)
390+
./mvnw test # Run tests
391391
./mvnw verify # Run unit tests + integration tests
392392
./mvnw install # Install to local Maven repository
393393
```
@@ -405,7 +405,7 @@ export GEMINI_API_KEY=your_key_here
405405
**Test Categories:**
406406
| Type | Command | Count | Requirements |
407407
|------|---------|-------|--------------|
408-
| Unit tests | `./mvnw test` | 258 | None |
408+
| Unit tests | `./mvnw test` | 370+ | None |
409409
| Clean shutdown IT | `./mvnw verify` | 4 | None |
410410
| Gemini CLI IT | `./mvnw verify` | 5 | `GEMINI_API_KEY`, `gemini` CLI in PATH |
411411

@@ -441,17 +441,37 @@ This SDK is part of the [Agent Client Protocol](https://agentclientprotocol.com/
441441

442442
**ACP directories:** [Agents](https://agentclientprotocol.com/overview/agents) | [Clients](https://agentclientprotocol.com/overview/clients) | [Protocol spec](https://agentclientprotocol.com/protocol/overview)
443443

444-
## Roadmap
444+
## Versioning
445445

446-
### v0.11.0 (Current — [Maven Central](https://central.sonatype.com/artifact/com.agentclientprotocol/acp-core))
446+
This SDK tracks the [ACP protocol](https://agentclientprotocol.com/), which is evolving. We don't promise strict semver — when the protocol changes, the SDK changes. What we do commit to:
447+
448+
- **Every breaking change is documented** in release notes. Nothing breaks silently.
449+
- **Deprecate before remove** where feasible.
450+
- **`@UnstableAcpApi`** marks protocol elements from `schema.unstable.json` — the most likely to change. But even stable APIs may change when the protocol requires it.
451+
452+
If you need a stable target, pin to an exact version.
453+
454+
## Releases
455+
456+
### 0.12.0-SNAPSHOT (Latest)
457+
458+
New stable methods: `session/list`, `session/close`, `session/resume`
459+
460+
New unstable methods (marked `@UnstableAcpApi`): `elicitation/create`, `elicitation/complete`, `session/fork`, `session/set_config_option`
461+
462+
```xml
463+
<repositories>
464+
<repository>
465+
<id>central-snapshots</id>
466+
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
467+
<snapshots><enabled>true</enabled></snapshots>
468+
<releases><enabled>false</enabled></releases>
469+
</repository>
470+
</repositories>
471+
```
472+
473+
### 0.11.0 (Stable — [Maven Central](https://central.sonatype.com/artifact/com.agentclientprotocol/acp-core))
447474
- Client and Agent SDKs with async/sync APIs
448475
- Stdio and WebSocket transports
449-
- Capability negotiation
450-
- Structured error handling
476+
- Capability negotiation, structured error handling
451477
- Full protocol compliance (all SessionUpdate types, MCP configs, `_meta` extensibility)
452-
- Own JSON abstraction layer (`AcpJsonMapper`) — no MCP SDK dependency
453-
- Pluggable JSON via `ServiceLoader` SPI
454-
455-
### v1.0.0 (Planned)
456-
- Production hardening
457-
- Performance optimizations

0 commit comments

Comments
 (0)