summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-08-12 21:22:12 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-08-12 21:22:12 +0300
commitdf84388ab71239e392837a548a3e1c4d54c4c5de (patch)
treecd76aca9497b744376384d819a9eb87133c19f09 /AGENTS.md
parente696fc296fb70c8e5db008b672905c745d7c09c9 (diff)
downloadcodecov-df84388ab71239e392837a548a3e1c4d54c4c5de.tar.gz
codecov-df84388ab71239e392837a548a3e1c4d54c4c5de.zip
seed: initial Codecov Global YAML + plumbing
Bootstrap content for the vyos org Codecov Global YAML mirror. codecov.yml is the comment-free dashboard-paste payload (Codecov strips comments on save); validate.yml gates all PRs against https://codecov.io/validate. AGENTS.md + README.md document the dashboard-paste protocol and language-applicability caveats. Companion repo: VyOS-Networks/codecov (filed Wave 2, ~1 week soak). Spec: [VYOS/894337074](https://vyos.atlassian.net/wiki/spaces/VYOS/pages/894337074) Phorge: T9078 IS: IS-609 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..c81cf6e
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,21 @@
+# Repo context for AI assistants
+
+This repo holds the **Codecov Global YAML** for the `vyos` GitHub organization.
+
+## What lives here
+- `codecov.yml` — the canonical, comment-free dashboard-paste payload. Mirror of
+ `https://app.codecov.io/account/gh/vyos/yaml`.
+- `.github/workflows/validate.yml` — required CI check; POSTs the file to
+ `https://codecov.io/validate` on every PR/push.
+- `.mergify.yml` — extends central [vyos/mergify](https://github.com/vyos/mergify).
+- `.coderabbit.yaml` — inherits from [vyos/coderabbit](https://github.com/vyos/coderabbit)
+ (`inheritance: true` is mandatory).
+- `README.md` — change protocol + dashboard-paste discipline.
+
+## Change protocol
+1. PRs only. No direct dashboard edits.
+2. Keep `codecov.yml` comment-free — Codecov strips comments on dashboard save; any
+ explanatory content lives here in AGENTS.md or in README.md.
+3. After merge to `production`, operator pastes from
+ `gh api repos/vyos/codecov/contents/codecov.yml?ref=production --jq '.content' | base64 -d`
+ into the dashboard. Repo is the source of truth; dashboard is a cache.