Skip to content

Commit 55705bd

Browse files
philprimeclaude
andcommitted
docs: Update AGENTS.md and README.md for current project state
AGENTS.md: - Add setup section (make init, pre-commit hooks) - Fix k8s client-go version (v0.25 → v0.35) - Fix Docker runtime image reference (distroless/static:nonroot) - Add go fix convention README.md: - Fix run command (go run . → go run ./cmd/agent) - Add make init to first-time setup instructions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 02110fe commit 55705bd

2 files changed

Lines changed: 11 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,19 @@ Co-Authored-By: (the agent model's name and attribution byline)
5454
- Enhancers enrich Sentry events with K8s metadata
5555
- Supports custom DSNs via `k8s.sentry.io/dsn` annotation
5656

57+
## Setup
58+
59+
- First-time setup: `make init` (installs Brew deps, Go modules, pre-commit hooks)
60+
- Pre-commit hooks run: build, test, go fix, vet, lint, and dprint formatting
61+
5762
## Key Conventions
5863

5964
- Logging: `github.com/rs/zerolog`
60-
- K8s client: `k8s.io/client-go` v0.25
65+
- K8s client: `k8s.io/client-go` v0.35
6166
- Error reporting: `github.com/getsentry/sentry-go`
62-
- Docker: multi-stage build, `gcr.io/distroless/static-debian12` runtime
67+
- Docker: multi-stage build, `gcr.io/distroless/static:nonroot` runtime
6368
- RBAC: read-only (`watch`, `list`, `get` only)
69+
- Run `go fix ./...` to apply Go modernizations (also in pre-commit)
6470

6571
## Environment Variables
6672

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,13 @@ In the Sentry Crons tab of the corresponding project, we may see the following:
185185

186186
b. Pass a valid Sentry DSN to an environment variable named `SENTRY_DSN` ([https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/](https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/))
187187

188-
c. At the root of the repository directory, build the Go module with the command
188+
c. At the root of the repository directory, initialize the project and build
189189

190-
`make build`
190+
`make init && make build`
191191

192192
d. Run the module outside of the k8s cluster by executing the command
193193

194-
`go run .`
194+
`go run ./cmd/agent`
195195

196196
which now starts up the process that automatically detects the cluster configuration in order to detect events
197197

0 commit comments

Comments
 (0)