diff --git a/CLAUDE.md b/CLAUDE.md index 6f5fddc8..4bb5bdb8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,42 +1,43 @@ # CLAUDE.md ## Project purpose The official Ansible Collection for managing VyOS network appliances (`vyos.vyos` namespace). Provides modules, plugins, action handlers, terminal plugins, and resource modules for BGP, OSPF, firewall, interfaces, NTP, etc. ## Tech stack - Ansible Collection (Galaxy). Python control-plane code under `plugins/`. - `galaxy.yml` declares `namespace: vyos`, `name: vyos`, `version: 6.0.0`, dep `ansible.netcommon >= 2.5.1`, license_file `LICENSE` (GPL-3.0). - Test stack: `pytest` + `tox-ansible.ini`; lint via flake8, isort, black (line-length 100), pre-commit, ansible-lint. - Runtime deps: `paramiko`, `scp` (`requirements.txt`); `bindep.txt` for system deps. ## Build / test / run - Build: `ansible-galaxy collection build` produces a `vyos-vyos-.tar.gz`. - Install local dev: `ansible-galaxy collection install . --force`. - Test: `tox -e ` (see `tox-ansible.ini`); run sanity / unit / integration tests against VyOS 1.3.8 / 1.4.1 / 1.5-rolling. ## Repository layout - `plugins/{action,cliconf,doc_fragments,filter,inventory,module_utils,modules,terminal}/` — collection content. - `tests/` — sanity, unit, integration; CI under `.github/workflows/tests.yml`. - `docs/` — generated module docs. - `meta/`, `changelogs/`, `CHANGELOG.rst` — Galaxy + release metadata. - `pyproject.toml` (black/pytest config), `.flake8`, `.isort.cfg`, `.ansible-lint`, `.pre-commit-config.yaml`. - `.github/workflows/` — `tests.yml`, `release.yml`, `codecoverage.yml`, `cla-check.yml`, `ah_token_refresh.yml`, `check_label.yaml`. ## Cross-repo context - Consumed by Ansible users running playbooks against VyOS routers built by `vyos/vyos-build`. - Sibling of `VyOS-Networks/vyos-ansible-collection` (older, mostly stale) and `VyOS-Networks/vyos-ansible-smoketests` (Jinja2 playbook smoketests driving this collection). - The `vyos.vyos` collection talks to VyOS via `network_cli` connections; supports the same train branches (`current`, `circinus`, `sagitta`, `equuleus`). ## Conventions -- Commit / PR title: `component: T12345: description` (Phorge ID at https://vyos.dev mandatory). +- Commit / PR title: `T12345: description` (Phorge ID at https://vyos.dev mandatory). +- Every PR must include exactly one changelog fragment under `changelogs/fragments/`; use `doc_changes` for documentation-only updates, or `trivial` for tooling / housekeeping changes. - Default branch `main` (not `current` — this repo predates the rename convention). - Issues tracked at https://vyos.dev (see `galaxy.yml`). - Codecov + CodeRabbit configured (`codecov.yml`, `.coderabbit.yaml`). ## Mirror relationship Twin at `VyOS-Networks/vyos.vyos`. Canonical side here. ## Notes for future contributors - Galaxy versioning is independent of VyOS train versioning — bump in `galaxy.yml` per release. - Tested matrix is in README; expand only after smoketesting against real images. - `PR408_README.md` plus `pr408-diagram.png` document a non-trivial historical refactor; read before touching resource-module structure. diff --git a/changelogs/fragments/T8595-claude-md.yml b/changelogs/fragments/T8595-claude-md.yml new file mode 100644 index 00000000..7903b083 --- /dev/null +++ b/changelogs/fragments/T8595-claude-md.yml @@ -0,0 +1,3 @@ +trivial: + - Add CLAUDE.md with project purpose, tech stack, build/test/run instructions, + repository layout, cross-repo context, conventions, and contributor notes.