summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-08 17:46:02 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-08 17:46:02 +0300
commit9ec756b4d52e8c61a65f702941acb42115769251 (patch)
treeb0725b0ffdac9b18402c9cbf813ed4602c5ed098
parent7a39c276da31959c9999c2e71f4714bda38ef0bc (diff)
downloadvyos.vyos-T8595-add-agents-md.tar.gz
vyos.vyos-T8595-add-agents-md.zip
general: T8595: address Copilot review threads on test command and commit conventionT8595-add-agents-md
- Line 15: add `ansible-test units` alongside the existing pytest command; the two correspond to the unit-galaxy and unit-source CI jobs respectively, so documenting both gives contributors accurate options for each CI path. - Line 30: change "Commit / PR title" to "Commit headline". No workflow in this repo enforces PR title format; the PR template checklist confirms only commit headlines must carry a Phorge task ID. 🤖 Generated by [robots](https://vyos.io)
-rw-r--r--AGENTS.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/AGENTS.md b/AGENTS.md
index ca3cc229..436b6785 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -12,7 +12,7 @@ The official Ansible Collection for managing VyOS network appliances (`vyos.vyos
## Build / test / run
- Build: `ansible-galaxy collection build` produces a `vyos-vyos-<version>.tar.gz`.
- Install local dev: `ansible-galaxy collection install . --force`.
-- Test (unit): `source .venv/bin/activate && PYTHONPATH=".collections" python -m pytest tests/unit` (config in `pyproject.toml`). CI (`.github/workflows/tests.yml`) runs the changelog / build-import / ansible-lint / sanity / unit-galaxy / unit-source jobs; integration tests live under `tests/integration/` but are not yet wired into CI. Per `README.md`, the collection targets VyOS 1.3.8 / 1.4.1 / 1.5-rolling (no version matrix in the workflow itself).
+- Test (unit): `ansible-test units` (matches `unit-galaxy` CI job; requires collection installed under `~/.ansible/collections/`). Fast local alternative: `source .venv/bin/activate && PYTHONPATH=".collections" python -m pytest tests/unit` (matches `unit-source` CI path; config in `pyproject.toml`). CI (`.github/workflows/tests.yml`) runs the changelog / build-import / ansible-lint / sanity / unit-galaxy / unit-source jobs; integration tests live under `tests/integration/` but are not yet wired into CI. Per `README.md`, the collection targets VyOS 1.3.8 / 1.4.1 / 1.5-rolling (no version matrix in the workflow itself).
## Repository layout
- `plugins/{action,cliconf,doc_fragments,filter,inventory,module_utils,modules,terminal}/` — collection content.
@@ -27,7 +27,7 @@ The official Ansible Collection for managing VyOS network appliances (`vyos.vyos
- The `vyos.vyos` collection talks to VyOS via `network_cli` connections; supports the same train branches (`current`, `circinus`, `sagitta`, `equuleus`).
## Conventions
-- Commit / PR title: `T12345: description` (Phorge ID at https://vyos.dev mandatory).
+- Commit headline: `T12345: description` (Phorge ID at https://vyos.dev mandatory). No workflow enforces PR title format in this repo.
- 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`).