Skip to content

Commit 65583e4

Browse files
docs: add AGENTS.md for agent discoverability (#34)
1 parent 9f2e470 commit 65583e4

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# deploydiff
2+
3+
## Purpose
4+
Compare deployment configurations across environments. Detect drift between staging and production configs. Preview infrastructure changes with human-readable diffs, cost impact estimation, and rollback commands.
5+
6+
## Build & Test Commands
7+
- Install: `pip install -e .` or `pip install deploydiff`
8+
- Test: `pytest tests/` (or `python -m pytest tests/ -v --tb=short`)
9+
- Lint: `ruff check .`
10+
- Build: `pip install build twine && python -m build && twine check dist/*`
11+
- CLI check: `deploydiff --help`
12+
13+
## Architecture
14+
Key directories:
15+
- `src/deploydiff/` — Main package (CLI, diff engine, cost estimator, rollback generator)
16+
- `tests/` — Test suite
17+
- `.github/workflows/` — CI/CD (auto-code-review.yml, ci.yml, pages.yml, publish.yml)
18+
- `dist/` — Built distributions
19+
20+
## Conventions
21+
- Language: Python 3.10+
22+
- Test framework: pytest
23+
- CI: GitHub Actions (auto-code-review.yml, ci.yml, pages.yml, publish.yml)
24+
- Linting: ruff
25+
- Build system: setuptools
26+
- Package layout: src/ layout
27+
- Dependencies: click, rich, pyyaml, tomli, jinja2
28+
- CLI entry point: deploydiff.cli:cli
29+
- Default branch: main

0 commit comments

Comments
 (0)