Skip to content

Commit 9d5ab96

Browse files
authored
docs(envd): document version bump requirement on behavioral changes (#2290)
The envd version in pkg/version.go must be bumped on every behavioral change, but this was only tribal knowledge. Document it in the envd README and CLAUDE.md so contributors and AI assistants are aware of the requirement.
1 parent 992b45d commit 9d5ab96

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ Client → Client-Proxy → API (REST) ⟷ PostgreSQL
130130
- Process management API: `/spec/process/process.proto`
131131
- Filesystem API: `/spec/filesystem/filesystem.proto`
132132
- Port: 49983
133+
- **Version in `pkg/version.go` must be bumped on every behavioral change** (not comments/docs-only changes)
133134

134135
**Client Proxy (`packages/client-proxy/`)** - Edge routing layer
135136
- Service discovery via Consul

packages/envd/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ Daemon that runs inside a sandbox that allows interacting with the sandbox via c
44

55
## Development
66

7+
### Versioning
8+
9+
The envd version in `pkg/version.go` must be bumped on every change that affects behavior (code changes, dependency updates, etc.). Pure comment or documentation changes that don't affect the compiled binary don't require a version bump.
10+
11+
### Running locally
12+
713
Run the following command to (re)build the envd daemon and start a Docker container with envd running inside:
814

915
```bash

0 commit comments

Comments
 (0)