Skip to content
This repository was archived by the owner on Feb 5, 2026. It is now read-only.

Commit dd20929

Browse files
docs: add CHANGELOG.md with historical release notes
Retroactively documents all releases from v0.1.0 to v0.4.0. Format follows Keep a Changelog (https://keepachangelog.com/). Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c0fbb08 commit dd20929

1 file changed

Lines changed: 106 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Changelog
2+
3+
All notable changes to keep-protocol will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.4.0] — 2026-02-03
11+
12+
### Added
13+
- `ensure_server()` auto-bootstrap function (KP-11)
14+
- Checks if port 9009 is accepting connections
15+
- Starts server via Docker if not running
16+
- Falls back to `go install` if Docker unavailable
17+
- Waits up to 30 seconds for server readiness
18+
- CI test workflow for Python and Go (KP-16)
19+
- Release workflow template for Linear issue structure
20+
- Mandatory staging workflow documentation
21+
22+
### Fixed
23+
- pytest fixture error in test suite
24+
- go vet scope to exclude reference code
25+
26+
### Documentation
27+
- Added `ensure_server()` usage to README
28+
- Refined virality plan for v0.3.0+
29+
- Sandbox testing step in release checklist
30+
31+
## [0.3.1] — 2026-02-03
32+
33+
### Fixed
34+
- Excluded `keep-protocol-clawhub/` from `go vet` (reference code, not buildable)
35+
- Updated release checklist with proper tag-first workflow
36+
37+
## [0.3.0] — 2026-02-03
38+
39+
### Added
40+
- **Discovery system** (KP-7)
41+
- `discover("info")` — server version, agents online, uptime
42+
- `discover("agents")` / `discover_agents()` — list connected agents
43+
- `discover("stats")` — scar exchange counts, total packets
44+
- **Endpoint caching**`~/.keep/endpoints.json`
45+
- **`from_cache()` client** — reconnect from cached endpoints
46+
- **Scar logging** — server tracks scar field exchanges
47+
- Discovery feature test suite (KP-10)
48+
49+
### Changed
50+
- Wire protocol now uses length-prefixed framing (KP-1)
51+
- `[4 bytes: uint32 big-endian length][N bytes: protobuf Packet]`
52+
- Maximum payload: 65,536 bytes
53+
- **Breaking:** Raw protobuf writes no longer accepted
54+
55+
### Documentation
56+
- SKILL.md for ClawHub/AI agent discovery (KP-6)
57+
- AGENTS.md for AI coding assistant integration
58+
- ClawHub publishing guide with registry workaround
59+
- Routing examples and v0.2.0 protocol docs (KP-4)
60+
61+
## [0.2.0] — 2026-02-03
62+
63+
### Added
64+
- **Agent-to-agent routing** (KP-2)
65+
- Server maintains identity-based routing table
66+
- First signed packet's `src` field registers the connection
67+
- `dst="bot:alice"` forwards to registered agent
68+
- **Persistent connections** with `listen()` in Python SDK (KP-3)
69+
- Length-prefixed wire framing (KP-1)
70+
71+
### Changed
72+
- Wire format requires 4-byte length prefix (breaking change from v0.1.x)
73+
74+
## [0.1.1] — 2026-02-02
75+
76+
### Added
77+
- Multi-arch Docker image (amd64 + arm64)
78+
79+
### Fixed
80+
- CI: Added `contents:read` permission to PyPI publish job
81+
- CI: Lowercase ghcr.io tags (Docker requires lowercase)
82+
83+
## [0.1.0] — 2026-02-02
84+
85+
### Added
86+
- Initial release
87+
- Go server with ed25519 signature verification
88+
- Python SDK (`KeepClient`)
89+
- Protobuf packet schema (`keep.proto`)
90+
- Docker image at `ghcr.io/clcrawford-dev/keep-server`
91+
- PyPI package `keep-protocol`
92+
93+
### Protocol
94+
- Packets must be ed25519 signed (unsigned = silent drop)
95+
- Fields: sig, pk, typ, id, src, dst, body, fee, ttl, scar
96+
- Default port: 9009
97+
98+
---
99+
100+
[Unreleased]: https://github.com/CLCrawford-dev/keep-protocol/compare/v0.4.0...HEAD
101+
[0.4.0]: https://github.com/CLCrawford-dev/keep-protocol/compare/v0.3.1...v0.4.0
102+
[0.3.1]: https://github.com/CLCrawford-dev/keep-protocol/compare/v0.3.0...v0.3.1
103+
[0.3.0]: https://github.com/CLCrawford-dev/keep-protocol/compare/v0.1.1...v0.3.0
104+
[0.2.0]: https://github.com/CLCrawford-dev/keep-protocol/compare/v0.1.1...v0.2.0
105+
[0.1.1]: https://github.com/CLCrawford-dev/keep-protocol/compare/v0.1.0...v0.1.1
106+
[0.1.0]: https://github.com/CLCrawford-dev/keep-protocol/releases/tag/v0.1.0

0 commit comments

Comments
 (0)