AGENTS.md
Guidance for coding agents working on the AB Framework deploy harness role.
Project Overview
The deploy harness owns generated Dockerfiles, Compose files, environment examples, deployment scripts, release runbooks, dev/prod separation, generated image build wiring, and generated <app>-deploy output.
Project Map
- .claude/deploy/AGENT.md defines the deploy role.
- .claude/deploy/README.md documents generated deploy expectations.
- .claude/deploy/scripts/README.md describes deployment script patterns.
- .claude/deploy/skeleton/ contains deploy starter files.
- .claude/agents/ab-framework-orchestrator.md assigns deploy work.
- .claude/scripts/verify-framework.mjs checks Dockerfile and Compose wiring.
Setup Commands
bashnode .claude/scripts/verify-framework.mjs
node .claude/scripts/lint-claude-harness.mjs
Change Rules For Agents
- Keep development and production Compose files separate.
- Build server, web, and admin images before running containers.
- Make deployment scripts idempotent and parameterized.
- Do not commit real secrets.
- Keep env examples placeholder-only.
- Preserve generated image names and service wiring expected by the verifier.
- Do not hardcode private ports or local machine paths in docs.
Verification
bashnode .claude/scripts/verify-framework.mjs
Inspect generated <app>-deploy output after skeleton changes.
Security Notes
Deployment scaffolds must avoid real secrets, private registry credentials, host-specific paths, and environment values. Use placeholders and document required variables without values.
PR Checklist
- Dev/prod Compose split remains clear.
- Scripts are idempotent.
- Env examples contain no real secrets.
- Framework verifier passes.