From 8ecdbeb9b4e5564a5b182dc3d77d7a0e7ff674f3 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Sat, 30 May 2026 12:55:15 +0300 Subject: T8595: add AGENTS.md (#17) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds AGENTS.md at repo root and .github/copilot-instructions.md symlink for GitHub Copilot code review compatibility (per T8595 spec). 🤖 Generated by [robots](https://vyos.io) --- .github/copilot-instructions.md | 1 + AGENTS.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 120000 .github/copilot-instructions.md create mode 100644 AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 120000 index 0000000..be77ac8 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1 @@ +../AGENTS.md \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..2c6e14d --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,38 @@ +# AGENTS.md — `vyos/mirror-canary` + +## Project purpose + +Canary / test-target repository for the VyOS mirror pipeline (Rollout 1a and beyond). It is the **source side** of the `vyos` → `VyOS-Networks` PR-mirror pair. Its sister repo `VyOS-Networks/mirror-canary` is the mirror destination. + +The repo exists solely to validate mirror-pipeline mechanics end-to-end: PR creation, App-token authentication, Mergify coupling, multi-branch backport, conflict detection, and mirror-refusal semantics. It is not a software product. + +## Sibling — not a mirror — pair + +`vyos/mirror-canary` (source) and `VyOS-Networks/mirror-canary` (destination) form a canary pair. Changes pushed to `vyos/mirror-canary` trigger the central reusable workflow (`vyos/.github/.github/workflows/pr-mirror-repo-sync.yml`) which opens a mirror PR on `VyOS-Networks/mirror-canary`. They are deliberately kept structurally symmetric so the pipeline can be tested without touching production repos. + +## Repository layout + +``` +README.md — human notes on canary test scenarios +tests/ — small text files used as test payloads for each scenario +``` + +## Tech stack + +- No build system, no language runtime required. +- Test payloads are plain text files committed to `tests/`. +- Mirror pipeline: GitHub Actions reusable workflow; Mergify central config (`extends: mergify`) on both sides. + +## Default branch and branch conventions + +Default branch: `rolling` (plus long-lived `sagitta` and `circinus` for backport testing). + +Commit title format: `T: ` or `test: ` for canary test commits. + +Do not commit credentials or secrets. + +## When to touch this repo + +- During mirror-pipeline rollout verification (Rollout 1a / 1b / 2 / 3 / 4 etc.) to smoke-test new pipeline behaviour. +- To add a new test scenario: create a small file under `tests/`, open a PR, and observe the mirror pipeline's response on `VyOS-Networks/mirror-canary`. +- Safe to discard test branches after verification; the default branch `rolling` is the durable baseline. -- cgit v1.2.3