Skip to content

Commit a1d2ae8

Browse files
authored
chore: prepare 0.8.0 release (#64)
* chore: prepare 0.8.0 release * chore: bump to 0.8.0
1 parent e21d8d0 commit a1d2ae8

File tree

5 files changed

+68
-14
lines changed

5 files changed

+68
-14
lines changed

.github/workflows/on-release-main.yml

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ on:
44
release:
55
types: [published]
66

7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: true
15+
716
jobs:
817
set-version:
918
runs-on: ubuntu-24.04
@@ -51,7 +60,7 @@ jobs:
5160
env:
5261
UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
5362

54-
deploy-docs:
63+
build-docs:
5564
needs: publish
5665
runs-on: ubuntu-latest
5766
steps:
@@ -61,14 +70,21 @@ jobs:
6170
- name: Set up the environment
6271
uses: ./.github/actions/setup-python-env
6372

64-
- name: Deploy documentation
65-
env:
66-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
67-
GIT_AUTHOR_NAME: acp-bot
68-
GIT_AUTHOR_EMAIL: noreply@github.com
69-
GIT_COMMITTER_NAME: acp-bot
70-
GIT_COMMITTER_EMAIL: noreply@github.com
71-
run: |
72-
git config user.name "$GIT_AUTHOR_NAME"
73-
git config user.email "$GIT_AUTHOR_EMAIL"
74-
uv run mkdocs gh-deploy --force --remote-branch gh-pages --remote-name origin
73+
- name: Build site
74+
run: uv run mkdocs build -f mkdocs.yml --clean
75+
76+
- name: Upload Pages artifact
77+
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
78+
with:
79+
path: site
80+
81+
deploy-docs:
82+
needs: build-docs
83+
runs-on: ubuntu-latest
84+
environment:
85+
name: github-pages
86+
url: ${{ steps.deployment.outputs.page_url }}
87+
steps:
88+
- name: Deploy to GitHub Pages
89+
id: deployment
90+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

docs/migration-guide-0.8.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Migrating to ACP Python SDK 0.8
2+
3+
ACP 0.8 keeps the 0.7 public surface but aligns the SDK with the latest ACP schema and tightens a few runtime behaviors. Most teams only need to review the updated schema and terminal helpers. This guide calls out the changes that can affect downstream agents, clients, and tests.
4+
5+
## 1. ACP schema bumped to 0.10.8
6+
7+
- Regenerate any internal copies of ACP schema-derived artifacts against 0.10.8.
8+
- If you vendor schema types, run `make gen-all` or your equivalent pipeline.
9+
- Helper types now include `SessionInfoUpdate` in the `SessionUpdate` union, so downstream code that exhaustively matches update variants should include it.
10+
11+
## 2. `TerminalHandle` removal
12+
13+
`TerminalHandle` is no longer part of the public API. If you referenced it directly, switch to the request/response models and terminal IDs returned by `CreateTerminalRequest`/`CreateTerminalResponse`.
14+
15+
Typical adjustment:
16+
17+
```python
18+
# Before (0.7.x)
19+
handle = await conn.create_terminal(...)
20+
await conn.terminal_output(session_id=..., terminal_id=handle.id)
21+
22+
# After (0.8.x)
23+
resp = await conn.create_terminal(...)
24+
await conn.terminal_output(session_id=..., terminal_id=resp.terminal_id)
25+
```
26+
27+
## 3. Larger default stdio buffer limits
28+
29+
The default stdio reader limit is now 50MB to support multimodal payloads. If you run in memory-constrained environments, explicitly set `stdio_buffer_limit_bytes` when calling `run_agent`.
30+
31+
```python
32+
await run_agent(agent, stdio_buffer_limit_bytes=2 * 1024 * 1024)
33+
```
34+
35+
## 4. Documentation and quickstart updates
36+
37+
Docs and settings examples have been refreshed for ACP 0.10.8. If you maintain internal onboarding material, sync it with the latest docs in `docs/`.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ nav:
1414
- Experimental Contrib: contrib.md
1515
- Releasing: releasing.md
1616
- 0.7 Migration Guide: migration-guide-0.7.md
17+
- 0.8 Migration Guide: migration-guide-0.8.md
1718
plugins:
1819
- search
1920
- mkdocstrings:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "agent-client-protocol"
3-
version = "0.7.1"
3+
version = "0.8.0"
44
description = "A Python implement of Agent Client Protocol (ACP, by Zed Industries)"
55
authors = [
66
{ name = "Chojan Shang", email = "psiace@apache.org" },

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)