Skip to content

Commit 2d3fd09

Browse files
SvenvDamclaude
andauthored
chore: add AGENTS.md and CLAUDE.md for AI agent context (#5)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent f2c3517 commit 2d3fd09

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

AGENTS.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Ploy
2+
3+
Terminal-based deployment tool for AWS services. Defines desired service versions in YAML config files and can verify/deploy them.
4+
5+
## Stack
6+
7+
- Go 1.23, modules
8+
- CLI framework: Cobra
9+
- AWS SDK v2 (Lambda, ECS, EventBridge)
10+
- Config format: YAML
11+
12+
## Project Structure
13+
14+
- `cmd/` - CLI commands (deploy, verify, update)
15+
- `engine/` - Deployment engines (Lambda, ECS, ECS Scheduled Tasks)
16+
- `deployments/` - Config parsing, deploy/verify/update orchestration
17+
- `utils/` - Shared helpers
18+
19+
## Development
20+
21+
No Makefile. Use standard Go commands:
22+
23+
```bash
24+
go build ./...
25+
go test ./...
26+
go install . # install locally
27+
```
28+
29+
## CI/CD
30+
31+
- **PR**: `go build ./...` (`.github/workflows/pr-build.yml`)
32+
- **Release**: Tag `v*.*.*` triggers GoReleaser (`.github/workflows/release.yml`). Create releases via GitHub UI. `source-deployments` picks up the latest release automatically.
33+
34+
## Architecture Notes
35+
36+
- Each deployment engine implements the `DeploymentEngine` interface in `engine/core.go` and registers itself via `RegisterDeploymentEngine` in an `init()` function.
37+
- Config files are per-environment YAML (e.g. `development.yml`, `production.yml`).
38+
- The `update` command only modifies the YAML file; it does not deploy. Run `deploy` separately.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)